Bruxton Logo

SIDXCameraGetDescription

Syntax

C/C++

int SIDXCameraGetDescription(void* camera, wchar_t* description, int length);

Visual Basic

Function SIDXCameraGetDescription(ByVal camera As Long, VARIANT* description) As Long

IGOR Pro

SIDXCameraGetDescription camera, description, status

Parameters

camera
The open camera handle created by either SIDXSettingsOpenCamera or SIDXCameraOpen or SIDXDialogCameraSelector or SIDXSettingsRestoreCamera.
description
A string variable to receive the description of the open camera. The description information is provided by the camera driver. The maximum string length will never be greater than Microsoft MAX_PATH.
length
The variable specifies the character count of the string to receive the description of the open camera.

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

Discussion

The function returns empty string for all cameras except CCD cameras from Andor Technology. The function is only available from SIDX 6.3.6 or later.