Bruxton Logo

SIDXModeGetCurrent

Syntax

C/C++

int SIDXModeGetCurrent(void* camera, int* current_mode);

Visual Basic

Function SIDXModeGetCurrent (ByVal camera As Long, current_mode As Long) As Long

IGOR Pro

SIDXModeGetCurrent camera, current_mode, status

ITT IDL

status = SIDXModeGetCurrent(camera, current_mode)

Parameters

camera
The open camera handle created by either SIDXSettingsOpenCamera or SIDXCameraOpen or SIDXDialogCameraSelector or SIDXSettingsRestoreCamera.
current_mode
A variable to receive the index of the current mode setting. The index is between zero and the available number of mode settings minus one.

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

Discussion

The function is only supported on Spectral Instruments G4 cameras. The function returns the index of the current selected mode choice. The index value should be between zero and the total mode count minus one. Use SIDXModeGetCount to get the mode count.