SetFeatureDescription

Description

Assigns a description to the specified feature.

[C++]
int SetFeatureDescription(const char* feature, const char* description);


Parameters [C/C++]

[in] const char* feature

Name of the feature to assign the description to.

[in] const char* description

Siring containing the description of the feature.

Return Values

S_OK

Success

E_FAIL

Failure

E_NOINTERFACE

Feature does not exist

Example

This fragment of code instantiates a camera object, creates an integer feature and sets its description:

static CGevCamera* m_pCamera;

m_pCamera = createCamera();

m_pCamera->CreateFeature(FEATURE_TYPE_INTEGER, "Contrast", "Analog", FEATURE_ACCESS_RW);

m_pCamera->SetFeatureDescription("Offset", "Contrast of the image in percent");

Remarks

The descriptions of features is available to remote client applications as part of the GenICam protocol.

Note that the camera must be in the disconnected state in order for this method to work.