GenICam_SDK.docx
20
csiSetFeatureEnum
Set an enumeration feature on the device
Syntax
csiSetFeatureEnum(csiHandle device, const char* parameterName, const char* value, csiModuleLevel module =
CSI_DEVICE_MODULE)
Parameters:
In: device: Handle provided by the
-function
parameterName: name (Not the display name!) of the enumeration to get
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:
Return value:
Returns csiSuccess or an error defined in the csiErr-Enum.
Comment:
To retrieve the possible values for this enumeration, two functions need to be called:
1.
: in the returned structure
, the element “enumCounter” indicates the number of available
entries
2.
The different entries can be retrieved by using
the function “
” simply by iterating
from 0 until the “enumCounter”-1
csiGetFeatureEnumEntryByIndex
Retrieve an enumeration feature from the device by using its index
Syntax
csiErr csiGetFeatureEnumEntryByIndex(csiHandle device, const char* parameterName, int32_t enumIndex,
csiFeatureParameter *featureParamOut, csiModuleLevel module = CSI_DEVICE_MODULE)
Parameters:
In: device: Handle provided by the
-function
parameterName: name (Not the display name!) of the enumeration to get
enumIndex: the index of the enumeration to get
module: Module for which the parameter should be retrieved. 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: featureParamOut: Name of the enumeration of the requested index
Return value:
Returns csiSuccess or an error defined in the csiErr-Enum.
Comment:
The enumeration string will be given in the
csiFeatureParameter
-structure: valueStr
csiGetFeatureEnumEntryByName
Syntax
csiErr csiGetFeatureEnumEntryByName(csiHandle device, const char* parameterName, const char* enumValue,
csiFeatureParameter *featureParamOut, csiModuleLevel module = CSI_DEVICE_MODULE)
Parameters:
In: device:
Handle provided by the
-function
parameterName: name (Not the display name!) of the enumeration to get
enumValue:
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: featureParamOut
Return value:
Returns csiSuccess or an error defined in the csiErr-Enum.
Comment:
csiRegisterInvalidateCB
Register an invalidation callback function to a specific feature by name
Syntax
csiErr csiRegisterInvalidateCB(csiHandle device, const char *featureName, CB_OBJECT objCB,
CB_FEATURE_INVALIDATED_PFN pfnFeatureInvalidateCB, csiModuleLevel module =
CSI_DEVICE_MODULE);
Parameters:
In: device:
Handle provided by the
-function
featureName
:
Name of the feature register the callback to
objCB
:
An user object that is passed as parameter to the callback function
pfnFeatureInvalidateCB
: The callback function
module:
Module for which the feature invalidation callback should be registered. Please use the enum
csiModuleLevel to select.
