Bruxton Logo

SIDXGainGetCurrent

Syntax

C/C++

int SIDXGainGetCurrent(void* camera, int* current_gain);

Visual Basic

Function SIDXGainGetCurrent (ByVal camera As Long, current_gain As Long) As Long

IGOR Pro

SIDXGainGetCurrent camera, current_gain, status

ITT IDL

status = SIDXGainGetCurrent(camera, current_gain)

Parameters

camera
The open camera handle created by either SIDXSettingsOpenCamera or SIDXCameraOpen or SIDXDialogCameraSelector or SIDXSettingsRestoreCamera.
current_gain
A variable to receive the index of the current gain setting. The index is between zero and the available number of gain settings - 1.

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

Discussion

The function returns the index of the current selected gain choice. The index value should be between zero and the total gain count minus one. Use SIDXGainGetCount to get the gain count.