Bruxton Logo

SIDXSettingGet

Syntax

C/C++

int SIDXSettingGet(void* camera, const wchar_t* tag, wchar_t* value, int value_length);

Visual Basic

Function SIDXSettingGet (ByVal camera As Long, tag As Variant, value As Variant) As Long

IGOR Pro

SIDXSettingGet camera, tag, value, status

ITT IDL

status = SIDXSettingGet(camera, tag, value)

Parameters

camera
The open camera handle created by either SIDXSettingsOpenCamera or SIDXCameraOpen or SIDXDialogCameraSelector or SIDXSettingsRestoreCamera.
tag
A string variable to specify the camera setting to get. The supported tag settings (by camera type) are:
value
A string variable to receive the value associated with the camera setting. For some of the paramters, the string variable also supplies the additional information as input required by the parameters. The supported value settings (by camera type) are:
value_length
The size of 'value_get' that receives the value.

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

Discussion

These supported tags and corresponding values are camera specific settings. For example, the user can input the tag "SIReadoutPort" and a value will be returned "1", which indicates to the user that Port A is being used for readout. For camera specific settings that can be set, see SIDXSettingSet.