GenICam_SDK.docx
18
csiIsCommandActive
Check if a command is still active
Syntax
csiErr csiIsCommandActive(csiHandle device, const char* parameterName, bool *isActive,
csiModuleLevel module = CSI_DEVICE_MODULE)
Parameters:
In: device: Handle provided by the
-function
parameterName: name (Not the display name!) of the command to execute
module: Module for which the parameter should be set. Please use the enum csiModuleLevel to select.
Determines if the parameter should be retrieved from the device-, transport layer-, interface- stream- or buffer-
module
Out:
isActive: Pointer to a bool-value where the current state of the command is written to (true: active, false: inactive)
Return value:
Returns csiSuccess or an error defined in the csiErr-Enum.
Comment:
If a lengthy operation is triggered, it is possible to check the current status by calling this command.
csiGetFeatureReg
Retrieve a register value from the device
Syntax
csiErr csiGetFeatureReg(csiHandle device, const char* parameterName, char* buffer, size_t* length,
csiModuleLevel module = CSI_DEVICE_MODULE)
Parameters:
In: device: Handle provided by the
-function
parameterName:
name (Not the display name!) of the feature to get
value:
module: Module for which the parameter should be set. Please use the enum csiModuleLevel to select.
Determines if the parameter should be retrieved from the device-, transport layer-, interface- stream- or buffer-
module
Out:
buffer: Pointer to a char-array where the current value of the feature will be written to
length: Current length of the retrieved data
Return value:
Returns csiSuccess or an error defined in the csiErr-Enum.
Comment:
To avoid unexpected behavior, it is recommended to retrieve the maximum buffer length before getting it from the device.
This can be achieved by using the function “
”. This function will provide all necessary information
about the parameter (including min and max values).
The register
length must not exceed the length given in the “featureRegLength”-parameter
csiSetFeatureReg
Set a register value on the device
Syntax
csiErr csiSetFeatureReg(csiHandle device, const char* parameterName,
const char* buffer, size_t length, csiModuleLevel module = CSI_DEVICE_MODULE)
Parameters:
In: device: Handle provided by the
-function
parameterName: name (Not the display name!) of the feature to set
buffer: pointer to the data which will be written to the r egister
length: number of bytes to write to the register
module: Module for which the register should be set. Please use the enum csiModuleLevel to select.
Determines if the register should be set on the device-, transport layer-, interface- stream- or buffer-
module
Out:
Return value:
Returns csiSuccess or an error defined in the csiErr-Enum.
Comment:
To avoid unexpected behavior, it is recommended to retrieve the maximum buffer length before setting it to the device.
This can be achieved by using the function “
”. This function will provide all necessary information
about the parameter (including min and max values).
The register length must not exceed the length given in the “featureRegLength”-parameter
