BGAPI2 PnP Event Functions

Functions related to the GenICam Plug and Play Events. More...

Typedefs

typedef struct BGAPI2_PnPEvent BGAPI2_PnPEvent
 Struct for pointers of type PnPEvent. More...
 

Functions

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_PnPEvent_GetSerialNumber (BGAPI2_PnPEvent *pnp_event, char *serial_number, bo_uint64 *string_length)
 Returns the serial number of pnp event. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_PnPEvent_GetPnPType (BGAPI2_PnPEvent *pnp_event, bo_uint64 *pnp_type)
 Returns the type of pnp event. More...
 
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_PnPEvent_GetID (BGAPI2_PnPEvent *pnp_event, char *ID, bo_uint64 *string_length)
 Returns the identifier of pnp event. More...
 

Detailed Description

Functions related to the GenICam Plug and Play Events.

Typedef Documentation

◆ BGAPI2_PnPEvent

Struct for pointers of type PnPEvent.

Function Documentation

◆ BGAPI2_PnPEvent_GetSerialNumber()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_PnPEvent_GetSerialNumber ( BGAPI2_PnPEvent pnp_event,
char *  serial_number,
bo_uint64 *  string_length 
)

Returns the serial number of pnp event.

Parameters
[in]pnp_eventPointer to the pnp event
[in,out]serial_numberNullptr to get string length or pointer to store result
[in,out]string_lengthResult size, length of version string (including string end zero)
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_BUFFERInternal error, destination buffer too small
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_PnPEvent_GetPnPType()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_PnPEvent_GetPnPType ( BGAPI2_PnPEvent pnp_event,
bo_uint64 *  pnp_type 
)

Returns the type of pnp event.

Parameters
[in]pnp_eventPointer to the pnp event
[out]pnp_typePointe to store the result
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters

◆ BGAPI2_PnPEvent_GetID()

BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_PnPEvent_GetID ( BGAPI2_PnPEvent pnp_event,
char *  ID,
bo_uint64 *  string_length 
)

Returns the identifier of pnp event.

Parameters
[in]pnp_eventPointer to the pnp event
[in,out]IDNullptr to get string length or pointer to store result
[in,out]string_lengthResult size, length of version string (including string end zero)
Return values
BGAPI2_RESULT_SUCCESSNo error
BGAPI2_RESULT_NOT_AVAILABLEInternal error, no identifier available
BGAPI2_RESULT_INVALID_BUFFERInternal error, destination buffer too small
BGAPI2_RESULT_INVALID_PARAMETERError for invalid parameters