BGAPI2 ...other stuff :)
Enumerations | |
enum | BGAPI2_RESULT_LIST { BGAPI2_RESULT_SUCCESS = 0, BGAPI2_RESULT_ERROR = -1001, BGAPI2_RESULT_NOT_INITIALIZED = -1002, BGAPI2_RESULT_NOT_IMPLEMENTED = -1003, BGAPI2_RESULT_RESOURCE_IN_USE = -1004, BGAPI2_RESULT_ACCESS_DENIED = -1005, BGAPI2_RESULT_INVALID_HANDLE = -1006, BGAPI2_RESULT_NO_DATA = -1008, BGAPI2_RESULT_INVALID_PARAMETER = -1009, BGAPI2_RESULT_TIMEOUT = -1011, BGAPI2_RESULT_ABORT = -1012, BGAPI2_RESULT_INVALID_BUFFER = -1013, BGAPI2_RESULT_NOT_AVAILABLE = -1014, BGAPI2_RESULT_OBJECT_INVALID = -1098, BGAPI2_RESULT_LOWLEVEL_ERROR = -1099 } |
An enumeration containing return result codes. More... | |
Functions | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_SetEnv (const char *producer_path) |
Sets the GENICAM_GENTL_PATHxx environment variable with given value. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_GetEnv (char *producer_path, bo_uint64 *string_length) |
Get the value of the GENICAM_GENTL_PATHxx environment variable. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_GetLastError (BGAPI2_RESULT *error_code, char *error_text, bo_uint64 *string_length) |
Returns a description of the last occurred error. More... | |
Detailed Description
Enumeration Type Documentation
◆ BGAPI2_RESULT_LIST
enum BGAPI2_RESULT_LIST |
An enumeration containing return result codes.
Function Documentation
◆ BGAPI2_SetEnv()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_SetEnv | ( | const char * | producer_path | ) |
Sets the GENICAM_GENTL_PATHxx environment variable with given value.
- Parameters
-
[in] producer_path New path for searching GenTL producers
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Error on setting environment variable
◆ BGAPI2_GetEnv()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_GetEnv | ( | char * | producer_path, |
bo_uint64 * | string_length | ||
) |
Get the value of the GENICAM_GENTL_PATHxx environment variable.
- Parameters
-
[in,out] producer_path Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Error on getting environment variable
- See also
- BGAPI2_System_GetID for detail how to retrieve strings with unknown size
◆ BGAPI2_GetLastError()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_GetLastError | ( | BGAPI2_RESULT * | error_code, |
char * | error_text, | ||
bo_uint64 * | string_length | ||
) |
Returns a description of the last occurred error.
- Parameters
-
[out] error_code Last error code [out] error_text Last error string [out] string_length Size of last error string
- Return values
-
BGAPI2_RESULT_SUCCESS No error
- Todo:
- Check Module