File version.h

FileList > docs > sw > include > opae > version.h

Go to the source code of this file.

• #include <opae/types.h>

Public Functions

Type	Name
fpga_result	fpgaGetOPAECBuildString (char * build_str, size_t len) Get build information about the OPAE library as a string.
fpga_result	fpgaGetOPAECVersion (fpga_version * version) Get version information about the OPAE library.
fpga_result	fpgaGetOPAECVersionString (char * version_str, size_t len) Get version information about the OPAE library as a string.

Macros

Type	Name
define	FPGA_BUILD_STR_MAX 41
define	FPGA_VERSION_STR_MAX 10

Public Functions Documentation

function fpgaGetOPAECBuildString

Get build information about the OPAE library as a string.

fpga_result fpgaGetOPAECBuildString (
    char * build_str,
    size_t len
) 

Retrieve the build identifier of the OPAE library.

Parameters:

• build_str String to copy build information into
• len Length of build_str

Returns:

FPGA_INVALID_PARAM if build_str is NULL, FPGA_EXCEPTION if the version string cannot be copied into build_str, FPGA_OK otherwise.

function fpgaGetOPAECVersion

Get version information about the OPAE library.

fpga_result fpgaGetOPAECVersion (
    fpga_version * version
) 

Retrieve major version, minor version, and revision information about the OPAE library.

Parameters:

• version FPGA version

Returns:

FPGA_INVALID_PARAM if any of the output parameters is NULL, FPGA_OK otherwise.

function fpgaGetOPAECVersionString

Get version information about the OPAE library as a string.

fpga_result fpgaGetOPAECVersionString (
    char * version_str,
    size_t len
) 

Retrieve major version, minor version, and revision information about the OPAE library, encoded in a human-readable string (e.g. "1.0.0").

Parameters:

• version_str String to copy version information into
• len Length of version_str

Returns:

FPGA_INVALID_PARAM if version_str is NULL, FPGA_EXCEPTION if the version string cannot be copied into version_str, FPGA_OK otherwise.

Macro Definition Documentation

define FPGA_BUILD_STR_MAX

#define FPGA_BUILD_STR_MAX 41

define FPGA_VERSION_STR_MAX

#define FPGA_VERSION_STR_MAX 10

---

The documentation for this class was generated from the following file docs/sw/include/opae/version.h