Bruxton Logo

SIDXModeGet

Syntax

C/C++

int SIDXModeGet(void* camera, int index, wchar_t* mode, int length);

Visual Basic

Function SIDXModeGet (ByVal camera As Long, ByVal index As Long, mode As Variant) As Long

IGOR Pro

SIDXModeGet camera, index, mode, status

ITT IDL

status = SIDXModeGet(camera, index, mode)

Parameters

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

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 description for the mode given the index of the mode. The mode index must be in the range zero to the mode count minus one. Use SIDXModeGetCount to get the mode count.