GetFeatureControl

Description

Returns the status of the specified control mode for the selected camera feature.


Syntax

[VB]
Value=objActiveDcam.GetFeatureControl ( Name, Control ) 

[C/C++]
HRESULT GetFeatureControl ( bstr Name, bstr Control, BOOL pValue );


Data Types [VB]

Name: String
Control: String
Return value: Boolean


Parameters [C/C++]

Name [in]

String specifying the name of the feature. In accordance with IIDC 1.31, one of the following names can be used:

"Brightness", "Exposure", "Sharpness", "WhiteBalance", "Hue", "Saturation", "Gamma", "Shutter", "Gain", "Iris", "Focus", "OpticalFilter", "Zoom", "Pan", "Tilt", "Temperature", "TriggerDelay", "WhiteShading".

Control [in]

String specifying the control mode. Use one of the following inquiries:

"OnOff" - to check if the feature is turned on

"Absolute" - to check if the absolute control of the feature is turned on

"Auto" - to check if the auto-control of the feature is turned on

"OnePush" - to check if the one-push operation for the feature is in progress

pValue [out, retval]

Pointer to the boolean value which is TRUE if the control mode is enabled and FALSE otherwise

Return Values

S_OK

Success

E_INVALIDARG

Feature or inquiry does not exist

E_FAIL

Failure

Example

This VB example sets implements a one-push white balance control and then waits for the operation to complete:

ActiveDcam1.SetFeatureControl "WhiteBalance","OnePush"

Do While (x = True)

x = ActiveDcam1.GetFeatureControl("WhiteBalance", "OnePush")

Loop

      
Remarks

If the currently selected camera does not support the specified feature or inquiry, the method will generate an error.