File containing SIDX root usage for reference. More...

#include "SIDXCConstants.h"

Functions
int	SIDXRootOpen (void &SIDXroot, const wchar_t license)
	The function returns a handle used to control SIDX. More...

int	SIDXRootClose (void *SIDXroot)
	Close SIDX. More...

void	SIDXRootGetLastError (void SIDXroot, wchar_t message, size_t length)
	The function translates the last error into a text string. More...

void	SIDXRootEnableCapabilities (void *SIDXroot, int capability)
	Enable a special camera capability. More...

int	SIDXRootArchiveOpen (void SIDXroot, const wchar_t path, void *&SIDXarchive)
	Open a file as an image archive. More...

int	SIDXRootCameraScan (void *SIDXroot)
	This operation scans the computer system to locate any available cameras. More...

int	SIDXRootCameraScanGetReport (void SIDXroot, wchar_t report, size_t length)
	Obtain a detailed report of all available cameras on the system. More...

int	SIDXRootCameraScanGetCount (void *SIDXroot, int &count)
	Return the number of connected camera count as the result of SIDXRootCameraScan. More...

int	SIDXRootCameraScanGetName (void SIDXroot, int index, wchar_t name, size_t length)
	Obtain the name of the camera corresponding to the index. More...

int	SIDXRootCameraScanGetLabel (void SIDXroot, int index, wchar_t label, size_t length)
	Obtain the label representing the camera. More...

int	SIDXRootCameraOpenName (void SIDXroot, const wchar_t name, void *&SIDXcamera)
	Connect to the specified camera by name. More...

int	SIDXRootSoftwareGetDescription (void SIDXroot, wchar_t description, size_t length)
	Obtain the software description as a text string. More...

int	SIDXRootSoftwareGetLicense (void SIDXroot, wchar_t license, size_t length)
	Obtain the software license string. More...

int	SIDXRootSoftwareGetSerial (void SIDXroot, wchar_t serial, size_t length)
	Obtain the software serial number as a text string. More...

int	SIDXRootSoftwareIsLicensed (void *SIDXroot, bool &licensed)
	Verify if the SIDX software license is valid. More...

int	SIDXRootSoftwareSetLicense (void SIDXroot, const wchar_t license)
	Sets an SIDX license. More...

int	SIDXRootStageOpen (void SIDXroot, const wchar_t name, const wchar_t port, void &SIDXstage)
	Open the stage controller, by name, on the specified port. More...

Detailed Description

File containing SIDX root usage for reference.

Function Documentation

int SIDXRootArchiveOpen	(	void *	SIDXroot,
		const wchar_t *	path,
		void *&	SIDXarchive
	)

Open a file as an image archive.

Parameters

SIDXroot	A handle value that references the SIDX root context.
path	The path to the image file to open.
SIDXarchive	A variable to receive a handle value used to control the image file.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXRootCameraOpenName	(	void *	SIDXroot,
		const wchar_t *	name,
		void *&	SIDXcamera
	)

Connect to the specified camera by name.

The camera name string can be only a driver name, for example, "PCO pixelfly" or "Andor Technology". In the case that a driver owns multiple cameras, the camera name string must include the the index value.

Parameters

SIDXroot	A handle value that references the SIDX root context.
name	A name string of the camera to open.
SIDXcamera	A variable to receive a handle value that references the open camera.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXRootCameraScan ( void * SIDXroot )

This operation scans the computer system to locate any available cameras.

The operation cannot be performed if SIDX has any cameras open. The number of available cameras may be zero or more. Use SIDXRootCameraScanGetCount to obtain the number of cameras found on the computer system. This value may be zero. The operation creates a text report that may be useful if unexpected results occur. Use SIDXRootCameraScanGetReport to obtain this report.

Parameters

SIDXroot A handle value that references the SIDX root context.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXRootCameraScanGetCount	(	void *	SIDXroot,
		int &	count
	)

Return the number of connected camera count as the result of SIDXRootCameraScan.

Parameters

SIDXroot	A handle value that references the SIDX root context.
count	A variable to receive an integer count of connected cameras, including any simulated cameras

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXRootCameraScanGetLabel	(	void *	SIDXroot,
		int	index,
		wchar_t *	label,
		size_t	length
	)

Obtain the label representing the camera.

The label is intended to be human readable.

Parameters

SIDXroot	A handle value that references the SIDX root context.
index	The index of the camera in the connected camera list.
label	A text string to receive the text label of camera given the index.
length	The character length of "label".

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXRootCameraScanGetName	(	void *	SIDXroot,
		int	index,
		wchar_t *	name,
		size_t	length
	)

Obtain the name of the camera corresponding to the index.

This name is used to open the camera.

Parameters

SIDXroot	A handle value that references the SIDX root context.
index	The index of the camera in the connected camera list.
name	A text string to receive the text name of camera given the index.
length	The character length of "name".

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXRootCameraScanGetReport	(	void *	SIDXroot,
		wchar_t *	report,
		size_t	length
	)

Obtain a detailed report of all available cameras on the system.

Parameters

SIDXroot	A handle value that references the SIDX root context.
report	A text string to receive the text report of camera scan result.
length	The character length of "report".

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXRootClose ( void * SIDXroot )

Close SIDX.

This should be the last call to SIDX before the object is discarded.

Parameters

SIDXroot A handle value that references the SIDX root context.

Returns: Non-zero if the function failed, zero if it succeeded.

void SIDXRootEnableCapabilities	(	void *	SIDXroot,
		int	capability
	)

Enable a special camera capability.

The supported capabilities are: 1000: Enable Photometrics PVCAM support 1001: Enable Princeton Instruments PVCAM support The function is only supported in WaveMetric IGOR Pro interface.

Parameters

SIDXroot	A handle value that references the SIDX root context.
capability	The capability to enable.

void SIDXRootGetLastError	(	void *	SIDXroot,
		wchar_t *	message,
		size_t	length
	)

The function translates the last error into a text string.

Parameters

SIDXroot	A handle value that references the SIDX root context.
message	A text string to receive the text associated with the last error.
length	The character length of "message".

int SIDXRootOpen	(	void *&	SIDXroot,
		const wchar_t *	license
	)

The function returns a handle used to control SIDX.

Parameters

SIDXroot	A variable to receive a handle value that references the SIDX root context.
license	A text string containing a valid SIDX license. If the string is null or invalid, SIDX will look for the license file.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXRootSoftwareGetDescription	(	void *	SIDXroot,
		wchar_t *	description,
		size_t	length
	)

Obtain the software description as a text string.

The software description includes the product and version, for example: 'SIDX 7.0.1'.

Parameters

SIDXroot	A handle value that references the SIDX root context.
description	A text string to receive the text description of the software.
length	The character length of "description".

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXRootSoftwareGetLicense	(	void *	SIDXroot,
		wchar_t *	license,
		size_t	length
	)

Obtain the software license string.

Parameters

SIDXroot	A handle value that references the SIDX root context.
license	A text string to receive the text license of the software.
length	The character length of "license".

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXRootSoftwareGetSerial	(	void *	SIDXroot,
		wchar_t *	serial,
		size_t	length
	)

Obtain the software serial number as a text string.

Parameters

SIDXroot	A handle value that references the SIDX root context.
serial	A text string to receive the text serial number of the software.
length	The character length of "serial".

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXRootSoftwareIsLicensed	(	void *	SIDXroot,
		bool &	licensed
	)

Verify if the SIDX software license is valid.

If the software is not licensed all SIDX calls will return an invalid operation status code.

Parameters

SIDXroot	A handle value that references the SIDX root context.
licensed	A value to receive a boolean value, true if the software is licensed, otherwise false.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXRootSoftwareSetLicense	(	void *	SIDXroot,
		const wchar_t *	license
	)

Sets an SIDX license.

If there is an existing license it will be overwritten.

Parameters

SIDXroot	A handle value that references the SIDX root context.
license	A text string software license code.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXRootStageOpen	(	void *	SIDXroot,
		const wchar_t *	name,
		const wchar_t *	port,
		void *&	SIDXstage
	)

Open the stage controller, by name, on the specified port.

Parameters

SIDXroot	A handle value that references the SIDX root context.
name	A text string containing the name of the stage. An empty string will return an error.
port	A string specifying the serial port to be used. An empty string will return an error.
SIDXstage	A variable to receive a handle value that references the open stage.

Returns: Non-zero if the function failed, zero if it succeeded.

Functions

Detailed Description

Function Documentation