GenICam_SDK.docx
19
csiGetFeatureParameter
Retrieve a specific feature from the device. Detailed information about this feature will be returned
Syntax
csiErr csiGetFeatureParameter(csiHandle device, const char* parameterName, csiFeatureParameter* featureParamOut,
csiModuleLevel module = CSI_DEVICE_MODULE)
Parameters:
In: device: Handle provided by the
-function
parameterName: name (Not the display name!) of the feature 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: featureParamOut
Return value:
Returns csiSuccess or an error defined in the csiErr-Enum.
Comment:
csiIterateFeatureTree
Provides a possibility to iterate through all available features on the camera
Syntax
csiErr csiIterateFeatureTree(csiHandle device, const char* rootFeatureName, uint32_t index, char* featureNameOut,
size_t nameBuffSize, csiFeatureType* type, csiModuleLevel module =
CSI_DEVICE_MODULE)
Parameters:
In:
device: Handle provided by the
-function
rootFeatureName: name of the feature to start from. To start from the very beginni
ng use “root”
index: This will indicate the number of the child element of the rootFeature to retrieve
nameBuffSize: size of the provided buffer for the featureNameOut
module: Module for which the feature tree should be iterated. Please use the enum csiModuleLevel to select.
Determines if the feature tree on the device-, transport layer-, interface- stream- or buffer-
module should be used
Out:
featureNameOut: name of the retrieved feature
type: type of the retrieved feature
Return value:
Returns csiSuccess or an error defined in the csiErr-Enum.
Comment:
If starting from the very beginning, use “Root” as rootFeatureName. From there call this function for each returned feature in
order to get all features of the device.
Please check the provided example “feature_iteration” for a template of usage.
csiGetFeatureEnum
Retrieve an enumeration feature from the device
Syntax
csiErr csiGetFeatureEnum(csiHandle device, const char* parameterName, 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
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: Structure which contains all necessary information about the requested feature:
the relevant entries of the csiFeatureParameter-structure:
enumCounter: Number of different enum-entries for the enumeration
enumIndex: Currently selected enumeration index
valueStr: name of the enum-entry
Return value:
Returns csiSuccess or an error defined in the csiErr-Enum.
Comment:
