Bruxton Logo

SIDXGainGet

Syntax

C/C++

int SIDXGainGet(void* camera, int index, wchar_t* gain, int length);

Visual Basic

Function SIDXGainGet (ByVal camera As Long, ByVal index As Long, gain As Variant) As Long

IGOR Pro

SIDXGainGet camera, index, gain, status

ITT IDL

status = SIDXGainGet(camera, index, gain)

Parameters

camera
The open camera handle created by either SIDXSettingsOpenCamera or SIDXCameraOpen or SIDXDialogCameraSelector or SIDXSettingsRestoreCamera.
index
A zero based gain index.
gain
A variable to receive the gain value as a string for the specified index.
length
Specify the size of the parameter 'gain' in characters.

The return value is non-zero if the function failed, zero if it succeeded.

Discussion

The function returns the actual gain value given the index of the gain. The gain index must be in the range zero to the gain count minus one. Use SIDXGainGetCount to get the gain count.