SIDXCDevice.h File Reference

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

#include "SIDXCConstants.h"

Go to the source code of this file.

Functions
int	SIDXDeviceActionDo (void *SIDXdevice, int setting, const wchar_t *command)
	Perform a device-specific action. More...
int	SIDXDeviceActionGetByItem (void *SIDXdevice, int index, int &setting)
	Obtain a handle for a device-specific action, based on the index of the action. More...
int	SIDXDeviceActionGetByName (void *SIDXdevice, const wchar_t *name, int &setting)
	Obtain a handle for a device-specific action, based on the name of the action. More...
int	SIDXDeviceActionGetCount (void *SIDXdevice, int &count)
	Obtain the total count of device-specific actions. More...
int	SIDXDeviceActionGetName (void *SIDXdevice, int index, wchar_t *name, size_t length)
	Obtain the name of a device-specific action, based on the index of the action. More...
int	SIDXDeviceDriverGetDescription (void *SIDXdevice, wchar_t *description, size_t length)
	Obtain the driver description. More...
int	SIDXDeviceDriverGetName (void *SIDXdevice, wchar_t *name, size_t length)
	Obtain the driver name. More...
int	SIDXDeviceDriverGetType (void *SIDXdevice, SIDXDriverType &type)
	Obtain the device vendor and device driver. More...
int	SIDXDeviceExtraBooleanGet (void *SIDXdevice, int setting, bool &value)
	Obtain the value of a device-specific setting. More...
int	SIDXDeviceExtraBooleanSet (void *SIDXdevice, int setting, bool value)
	Set the device-specific setting to the specified boolean value. More...
int	SIDXDeviceExtraGetByItem (void *SIDXdevice, int item, int &setting)
	Obtain a handle for a device-specific setting, based on the item of the setting. More...
int	SIDXDeviceExtraGetByName (void *SIDXdevice, const wchar_t *name, int &setting)
	Obtain a handle for a device-specific setting, based on the name of the setting. More...
int	SIDXDeviceExtraGetCount (void *SIDXdevice, int &count)
	Obtain the total count of device-specific settings. More...
int	SIDXDeviceExtraGetLabel (void *SIDXdevice, int setting, wchar_t *label, size_t length)
	Obtain a label for the device-specific setting as a text string. More...
int	SIDXDeviceExtraGetName (void *SIDXdevice, int item, wchar_t *name, size_t length)
	Obtain the name of a device-specific setting, based on the item of the setting. More...
int	SIDXDeviceExtraGetType (void *SIDXdevice, int setting, SIDXSettingType &type)
	Obtain the type of a device-specific setting. More...
int	SIDXDeviceExtraGetUnit (void *SIDXdevice, int setting, wchar_t *unit, size_t length)
	Obtain the unit for the device-specific setting as a text string. More...
int	SIDXDeviceExtraGetValueLocal (void *SIDXdevice, int setting, wchar_t *description, size_t length)
	Obtain the current value of a device-specific setting as a text string. More...
int	SIDXDeviceExtraIntegerGet (void *SIDXdevice, int setting, int &value)
	Obtain the value of a device-specific setting. More...
int	SIDXDeviceExtraIntegerGetRange (void *SIDXdevice, int setting, int &minimum, int &maximum)
	Obtain the minimum and maximum value for a device-specific setting. More...
int	SIDXDeviceExtraIntegerGetValue (void *SIDXdevice, int setting, int &value)
	Obtain the value used by the camera for a device-specific setting. More...
int	SIDXDeviceExtraIntegerSet (void *SIDXdevice, int setting, int value)
	Set the device-specific setting to the specified integer value. More...
int	SIDXDeviceExtraIsSettable (void *SIDXdevice, int setting, bool &settable)
	Determine is the camera specific setting can be set, based on the returned setting handle. More...
int	SIDXDeviceExtraListGet (void *SIDXdevice, int setting, int &index)
	Obtain the current index value of the device-specific setting. More...
int	SIDXDeviceExtraListGetCount (void *SIDXdevice, int setting, int &count)
	Obtain the count of available values for a given device-specific setting. More...
int	SIDXDeviceExtraListGetEntry (void *SIDXdevice, int setting, int index, double &entry)
	Obtain the value associated with a specific device-specific setting index. More...
int	SIDXDeviceExtraListGetLocal (void *SIDXdevice, int setting, int index, wchar_t *description, size_t length)
	Obtain a description of a specific entry for a device-specific setting. More...
int	SIDXDeviceExtraListGetValue (void *SIDXdevice, int setting, double &value)
	Obtain the value of a device-specific setting. More...
int	SIDXDeviceExtraListSet (void *SIDXdevice, int setting, int index)
	Set the device-specific setting to the specified list index. More...
int	SIDXDeviceExtraListSetValue (void *SIDXdevice, int setting, double value)
	Set the device-specific setting to the specified real (floating-point) value. More...
int	SIDXDeviceExtraRealGet (void *SIDXdevice, int setting, double &value)
	Obtain the value of a device-specific setting. More...
int	SIDXDeviceExtraRealGetRange (void *SIDXdevice, int setting, double &minimum, double &maximum)
	Obtain the minimum and maximum value for a device-specific setting. More...
int	SIDXDeviceExtraRealGetValue (void *SIDXdevice, int setting, double &value)
	Obtain the value used by the device for a device-specific setting. More...
int	SIDXDeviceExtraRealSet (void *SIDXdevice, int setting, double value)
	Set the device-specific setting to the specified real value. More...
int	SIDXDeviceExtraSequenceGet (void *SIDXdevice, int setting, int *value, size_t length, size_t &return_length)
	Obtain the value of a device-specific setting. More...
int	SIDXDeviceExtraSequenceGetSize (void *SIDXdevice, int setting, int &size)
	Obtain the array size for a device-specific setting. More...
int	SIDXDeviceExtraSequenceSet (void *SIDXdevice, int setting, const int *value, size_t length)
	Set the device-specific setting to the specified array of integer value. More...
int	SIDXDeviceExtraStringGet (void *SIDXdevice, int setting, wchar_t *value, size_t length)
	Obtain the value of a device-specific setting. More...
int	SIDXDeviceExtraStringSet (void *SIDXdevice, int setting, const wchar_t *value)
	Set the device-specific setting to the specified text string value. More...
int	SIDXDeviceGetDescription (void *SIDXdevice, wchar_t *description, size_t length)
	Obtain a description of the device. More...
int	SIDXDeviceGetLabel (void *SIDXdevice, wchar_t *label, size_t length)
	Obtain a human readable label representing the device. More...
int	SIDXDeviceGetName (void *SIDXdevice, wchar_t *name, size_t length)
	Obtain the name of the device. More...
int	SIDXDevicePortAnalogGetRange (void *SIDXdevice, int port, double &minimum, double &maximum)
	Obtain the minimum and maximum analogue output voltage values. More...
int	SIDXDevicePortAnalogRead (void *SIDXdevice, int port, double &voltage)
	Obtains the voltage on the specified port. More...
int	SIDXDevicePortAnalogWrite (void *SIDXdevice, int port, double voltage)
	Sets the voltage as a fraction of maximum possible on the specified port. More...
int	SIDXDevicePortBitRead (void *SIDXdevice, int port, bool &asserted)
	Gets the status of the digital input bit specified by the index parameter, as retrieved by the most recent successful DigitalQuery. More...
int	SIDXDevicePortBitWrite (void *SIDXdevice, int port, bool asserted)
	Sets the digital output bit specified by the index parameter to the value specified by the asserted parameter. More...
int	SIDXDevicePortDigitalRead (void *SIDXdevice, int port, int &value)
	Gets the digital input value. More...
int	SIDXDevicePortDigitalWrite (void *SIDXdevice, int port, int value)
	Sets the digital output bits to the values specified by the data parameter. More...
int	SIDXDevicePortGetCount (void *SIDXdevice, int &count)
	Obtains the I/O port count. More...
int	SIDXDevicePortGetType (void *SIDXdevice, int port, SIDXPortType &type)
	Obtains the available port type for a given port index. More...
void	SIDXDeviceGetLastError (void *SIDXdevice, wchar_t *message, size_t length)
	The function translates the error code into a text string. More...

Detailed Description

File containing SIDX device usage for reference.

Function Documentation

int SIDXDeviceActionDo	(	void *	SIDXdevice,
		int	setting,
		const wchar_t *	command
	)

Perform a device-specific action.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the handle for the action.
command	A text string to be passed to the action. The meaning of the text string is action-specific. For many actions, the text string is not used and may be empty.

Returns

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

int SIDXDeviceActionGetByItem	(	void *	SIDXdevice,
		int	index,
		int &	setting
	)

Obtain a handle for a device-specific action, based on the index of the action.

Parameters

SIDXdevice	A handle value that references the open device context.
index	An integer index of the action within the actions available for the camera. The first action available for the camera has index zero.
setting	A variable to receive an integer value representing the action setting value corresponding to the name. The handle value is zero if the index does not correspond to an action for the specific camera.

Returns

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

int SIDXDeviceActionGetByName	(	void *	SIDXdevice,
		const wchar_t *	name,
		int &	setting
	)

Obtain a handle for a device-specific action, based on the name of the action.

Parameters

SIDXdevice	A handle value that references the open device context.
name	A text string containing the action name.
setting	A variable to receive an integer value representing the action setting value corresponding to the name. The handle value is zero if the name does not correspond to an action for the specific camera.

Returns

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

int SIDXDeviceActionGetCount	(	void *	SIDXdevice,
		int &	count
	)

Obtain the total count of device-specific actions.

Parameters

SIDXdevice	A handle value that references the open device context.
count	A variable to receive an integer value representing the total count of device-specific actions. This value may be zero if the camera has no device-specific actions.

Returns

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

int SIDXDeviceActionGetName	(	void *	SIDXdevice,
		int	index,
		wchar_t *	name,
		size_t	length
	)

Obtain the name of a device-specific action, based on the index of the action.

The name is consistent over time, so the same device-specific action always has the same name for a specific camera vendor. The name does not change across sessions.

Parameters

SIDXdevice	A handle value that references the open device context.
index	An integer index of the action within the actions available for the camera. The first action available for the camera has index zero.
name	A variable to receive a text string representing the action name.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

Returns

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

int SIDXDeviceDriverGetDescription	(	void *	SIDXdevice,
		wchar_t *	description,
		size_t	length
	)

Obtain the driver description.

The description text string is driver specific information. For example, it could contain the version number. The driver description may be useful for identifying the driver if you are having trouble with the driver.

Parameters

SIDXdevice	A handle value that references the open device context.
description	A variable to receive a text string description representing the driver. This description is intended for reporting to the user.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

Returns

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

int SIDXDeviceDriverGetName	(	void *	SIDXdevice,
		wchar_t *	name,
		size_t	length
	)

Obtain the driver name.

Typically the name is a text string that identifies the vendor and if necessary the specific driver. For example, if the vendor 'Acme' has two drives, 'Standard' and 'Plus', the driver name might be 'Acme Standard' or 'Acme Plus'.

Parameters

SIDXdevice	A handle value that references the open device context.
name	A variable to receive a text string name representing the driver.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

Returns

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

int SIDXDeviceDriverGetType	(	void *	SIDXdevice,
		SIDXDriverType &	type
	)

Obtain the device vendor and device driver.

Parameters

SIDXdevice	A handle value that references the open device context.
type	A variable to receive a value describing the device vendor and device driver type.

Returns

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

int SIDXDeviceExtraBooleanGet	(	void *	SIDXdevice,
		int	setting,
		bool &	value
	)

Obtain the value of a device-specific setting.

This operation is valid only if the device-specific setting is a boolean type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	A variable to receive a boolean value representing the current setting.

Returns

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

int SIDXDeviceExtraBooleanSet	(	void *	SIDXdevice,
		int	setting,
		bool	value
	)

Set the device-specific setting to the specified boolean value.

This operation is valid only if the device-specific setting is a boolean type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	A boolean value to set.

Returns

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

int SIDXDeviceExtraGetByItem	(	void *	SIDXdevice,
		int	item,
		int &	setting
	)

Obtain a handle for a device-specific setting, based on the item of the setting.

Parameters

SIDXdevice	A handle value that references the open device context.
item	An integer value containing the item of the device-specific setting. The first setting has item zero.
setting	A variable to receive an integer value representing the setting value corresponding to the name. The value is zero if the item does not correspond to a setting for the specific camera.

Returns

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

int SIDXDeviceExtraGetByName	(	void *	SIDXdevice,
		const wchar_t *	name,
		int &	setting
	)

Obtain a handle for a device-specific setting, based on the name of the setting.

Parameters

SIDXdevice	A handle value that references the open device context.
name	A text string containing the setting name.
setting	A variable to receive an integer value representing the setting value corresponding to the name. The value is zero if the name does not correspond to a setting for the specific camera.

Returns

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

int SIDXDeviceExtraGetCount	(	void *	SIDXdevice,
		int &	count
	)

Obtain the total count of device-specific settings.

Parameters

SIDXdevice	A handle value that references the open device context.
count	A variable to receive an integer value representing the total count of device-specific settings. This value may be zero if the camera has no device-specific settings.

Returns

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

int SIDXDeviceExtraGetLabel	(	void *	SIDXdevice,
		int	setting,
		wchar_t *	label,
		size_t	length
	)

Obtain a label for the device-specific setting as a text string.

Typical label text strings are "Trigger edge" or "Serial shift time". These text strings are intended for display to a user.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
label	A variable to receive a text string representing the setting label, as a text string. If the handle is valid, the label will never be empty. If the handle is not valid, the label will be null.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

Returns

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

int SIDXDeviceExtraGetName	(	void *	SIDXdevice,
		int	item,
		wchar_t *	name,
		size_t	length
	)

Obtain the name of a device-specific setting, based on the item of the setting.

The name is consistent over time, so the same device-specific setting always has the same name for a specific camera vendor. The name does not change across sessions.

Parameters

SIDXdevice	A handle value that references the open device context.
item	An integer value containing the item of the device-specific setting. The first setting has item zero.
name	A variable to receive a text string representing the setting name.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

Returns

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

int SIDXDeviceExtraGetType	(	void *	SIDXdevice,
		int	setting,
		SIDXSettingType &	type
	)

Obtain the type of a device-specific setting.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
type	A variable to receive a value describing the type of the device-specific setting. If the handle is not valid, the setting type is none.

Returns

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

int SIDXDeviceExtraGetUnit	(	void *	SIDXdevice,
		int	setting,
		wchar_t *	unit,
		size_t	length
	)

Obtain the unit for the device-specific setting as a text string.

Typical unit text strings are "ms" or "kHz". These unit text strings are intended for display to a user. Some device-specific settings may not have any units, the string will be empty. The setting units are independent of the setting value.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
unit	A variable to receive a text string representing the setting unit, as a text string. The text string will be empty if the setting has no units. The text string will be null if the handle is not valid.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

Returns

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

int SIDXDeviceExtraGetValueLocal	(	void *	SIDXdevice,
		int	setting,
		wchar_t *	description,
		size_t	length
	)

Obtain the current value of a device-specific setting as a text string.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
description	A variable to receive a text string description of the current value of the setting.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

Returns

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

int SIDXDeviceExtraIntegerGet	(	void *	SIDXdevice,
		int	setting,
		int &	value
	)

Obtain the value of a device-specific setting.

This operation is valid only if the device-specific setting is an integer type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	A variable to receive an integer value representing the setting value.

Returns

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

int SIDXDeviceExtraIntegerGetRange	(	void *	SIDXdevice,
		int	setting,
		int &	minimum,
		int &	maximum
	)

Obtain the minimum and maximum value for a device-specific setting.

This operation is valid only if the device-specific setting is an integer type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
minimum	A variable to receive an integer value representing the minimum limit.
maximum	A variable to receive an integer value representing the maximum limit.

Returns

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

int SIDXDeviceExtraIntegerGetValue	(	void *	SIDXdevice,
		int	setting,
		int &	value
	)

Obtain the value used by the camera for a device-specific setting.

This operation is valid only if the device-specific setting is an integer type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	A variable to receive an integer value representing the setting value used by the camera.

Returns

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

int SIDXDeviceExtraIntegerSet	(	void *	SIDXdevice,
		int	setting,
		int	value
	)

Set the device-specific setting to the specified integer value.

This operation is valid only if the device-specific setting is an integer type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	The integer value to set. The value must be valid for the setting.

Returns

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

int SIDXDeviceExtraIsSettable	(	void *	SIDXdevice,
		int	setting,
		bool &	settable
	)

Determine is the camera specific setting can be set, based on the returned setting handle.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
settable	A variable to receive a boolean value to determine whether the setting parameter is settable.

Returns

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

int SIDXDeviceExtraListGet	(	void *	SIDXdevice,
		int	setting,
		int &	index
	)

Obtain the current index value of the device-specific setting.

This operation is valid only if the device-specific setting is a list type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
index	A variable to receive an integer value representing the index of the entry in the setting list.

Returns

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

int SIDXDeviceExtraListGetCount	(	void *	SIDXdevice,
		int	setting,
		int &	count
	)

Obtain the count of available values for a given device-specific setting.

This operation is valid only if the setting type is 'list', the value returned is the total number of settings in the list.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
count	A variable to receive an integer value count containing the number of list entries for the device-specific setting. If the handle is not valid, or if the setting is not a 'list', this value is zero.

Returns

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

int SIDXDeviceExtraListGetEntry	(	void *	SIDXdevice,
		int	setting,
		int	index,
		double &	entry
	)

Obtain the value associated with a specific device-specific setting index.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
index	An integer index of the setting within the setting list. The first index in the setting list has index zero.
entry	A variable to receive a real (floating-point) value representing the entry associated with the specific index.

Returns

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

int SIDXDeviceExtraListGetLocal	(	void *	SIDXdevice,
		int	setting,
		int	index,
		wchar_t *	description,
		size_t	length
	)

Obtain a description of a specific entry for a device-specific setting.

This operation is valid only if the device-specific setting is a list type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
index	An integer index of the setting within the setting list. The first index in the setting list has index zero.
description	A variable to receive a text string description of the specific index.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

Returns

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

int SIDXDeviceExtraListGetValue	(	void *	SIDXdevice,
		int	setting,
		double &	value
	)

Obtain the value of a device-specific setting.

This operation is valid only if the device-specific setting is a list type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	A variable to receive a real (floating-point) value representing the setting. The value is device-specific, the same value may represent a different setting on different cameras. However, the value should be consistent, so it should be possible restore the camera to the same setting later by setting the camera to this value.

Returns

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

int SIDXDeviceExtraListSet	(	void *	SIDXdevice,
		int	setting,
		int	index
	)

Set the device-specific setting to the specified list index.

This operation is valid only if the device specific setting is a list type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
index	An integer index of the setting within the setting list. The first entry in the setting list has index zero.

Returns

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

int SIDXDeviceExtraListSetValue	(	void *	SIDXdevice,
		int	setting,
		double	value
	)

Set the device-specific setting to the specified real (floating-point) value.

This operation is valid only if the device-specific setting is a list type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	A real (floating-point) value to set. The value must be valid for the setting. The value is device-specific.

Returns

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

int SIDXDeviceExtraRealGet	(	void *	SIDXdevice,
		int	setting,
		double &	value
	)

Obtain the value of a device-specific setting.

This operation is valid only if the device-specific setting is a real type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	A variable to receive a real (floating-point) value representing the current setting value.

Returns

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

int SIDXDeviceExtraRealGetRange	(	void *	SIDXdevice,
		int	setting,
		double &	minimum,
		double &	maximum
	)

Obtain the minimum and maximum value for a device-specific setting.

This operation is valid only if the device-specific setting is a real type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
minimum	A variable to receive a real (floating point) value representing the minimum limit.
maximum	A variable to receive a real (floating point) value representing the maximum limit.

Returns

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

int SIDXDeviceExtraRealGetValue	(	void *	SIDXdevice,
		int	setting,
		double &	value
	)

Obtain the value used by the device for a device-specific setting.

This operation is valid only if the device-specific setting is a real type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	A variable to receive a real (floating-point) value representing the setting value used by the device.

Returns

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

int SIDXDeviceExtraRealSet	(	void *	SIDXdevice,
		int	setting,
		double	value
	)

Set the device-specific setting to the specified real value.

This operation is valid only if the device specific setting is a real type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	The real (floating-point) value to set.

Returns

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

int SIDXDeviceExtraSequenceGet	(	void *	SIDXdevice,
		int	setting,
		int *	value,
		size_t	length,
		size_t &	return_length
	)

Obtain the value of a device-specific setting.

This operation is valid only if the device-specific setting is an array of integer type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	A variable to receive an array of integer value representing the current setting.
length	The length of the array, in units of entries. This is the maximum number of entries that can be written into the array.
return_length	An integer variable to receive the length of the array, in units of entries.

Returns

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

int SIDXDeviceExtraSequenceGetSize	(	void *	SIDXdevice,
		int	setting,
		int &	size
	)

Obtain the array size for a device-specific setting.

This operation is valid only if the device-specific setting is an array of integer type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
size	A variable to receive an integer value representing the size of the array length, measured in units of integer, for the setting.

Returns

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

int SIDXDeviceExtraSequenceSet	(	void *	SIDXdevice,
		int	setting,
		const int *	value,
		size_t	length
	)

Set the device-specific setting to the specified array of integer value.

This operation is valid only if the device-specific setting is an array of integer type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	An array of integer value to set.
length	The length of the array, in units of entries. This is the maximum number of entries that can be written into the array

Returns

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

int SIDXDeviceExtraStringGet	(	void *	SIDXdevice,
		int	setting,
		wchar_t *	value,
		size_t	length
	)

Obtain the value of a device-specific setting.

This operation is valid only if the device-specific setting is a text string type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	A variable to receive a text string value representing the current setting.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

Returns

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

int SIDXDeviceExtraStringSet	(	void *	SIDXdevice,
		int	setting,
		const wchar_t *	value
	)

Set the device-specific setting to the specified text string value.

This operation is valid only if the device-specific setting is a text string type.

Parameters

SIDXdevice	A handle value that references the open device context.
setting	An integer value containing the setting identifier.
value	A text string value to set.

Returns

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

int SIDXDeviceGetDescription	(	void *	SIDXdevice,
		wchar_t *	description,
		size_t	length
	)

Obtain a description of the device.

The description contains information that may be helpful for you to identify the device to the vendor.

Parameters

SIDXdevice	A handle value that references the open device context.
description	A variable to receive a text string description of the device.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

Returns

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

int SIDXDeviceGetLabel	(	void *	SIDXdevice,
		wchar_t *	label,
		size_t	length
	)

Obtain a human readable label representing the device.

Parameters

SIDXdevice	A handle value that references the open device context.
label	A variable to receive a text string label representing the device.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

Returns

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

void SIDXDeviceGetLastError	(	void *	SIDXdevice,
		wchar_t *	message,
		size_t	length
	)

The function translates the error code into a text string.

Parameters

SIDXdevice	A handle value that references the open device context.
message	A text string to receive the text associated with the last error occurred.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

int SIDXDeviceGetName	(	void *	SIDXdevice,
		wchar_t *	name,
		size_t	length
	)

Obtain the name of the device.

Parameters

SIDXdevice	A handle value that references the open device context.
name	A variable to receive a text string name representing the device.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

Returns

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

int SIDXDevicePortAnalogGetRange	(	void *	SIDXdevice,
		int	port,
		double &	minimum,
		double &	maximum
	)

Obtain the minimum and maximum analogue output voltage values.

Parameters

SIDXdevice	A handle value that references the open device context.
port	An integer value representing the index of the port.
minimum	A variable to receive a real (floating point) value representing the minimum limit, in Volt.
maximum	A variable to receive a real (floating point) value representing the maximum limit, in Volt.

Returns

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

int SIDXDevicePortAnalogRead	(	void *	SIDXdevice,
		int	port,
		double &	voltage
	)

Obtains the voltage on the specified port.

Parameters

SIDXdevice	A handle value that references the open device context.
port	An integer value representing the index of the port.
voltage	A variable to receive a real (floating-point) value representing the input voltage, in Volt.

Returns

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

int SIDXDevicePortAnalogWrite	(	void *	SIDXdevice,
		int	port,
		double	voltage
	)

Sets the voltage as a fraction of maximum possible on the specified port.

Parameters

SIDXdevice	A handle value that references the open device context.
port	An integer value representing the index of the port.
voltage	A real (floating-point) value representing the output voltage, in Volt.

Returns

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

int SIDXDevicePortBitRead	(	void *	SIDXdevice,
		int	port,
		bool &	asserted
	)

Gets the status of the digital input bit specified by the index parameter, as retrieved by the most recent successful DigitalQuery.

Parameters

SIDXdevice	A handle value that references the open device context.
port	An integer value representing the index of the port.
asserted	A variable to receive a boolean value, true if asserted, false otherwise.

Returns

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

int SIDXDevicePortBitWrite	(	void *	SIDXdevice,
		int	port,
		bool	asserted
	)

Sets the digital output bit specified by the index parameter to the value specified by the asserted parameter.

Parameters

SIDXdevice	A handle value that references the open device context.
port	An integer value representing the index of the port.
asserted	A boolean value, true if the specified output bit is asserted. False if the specified output bit is de-asserted.

Returns

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

int SIDXDevicePortDigitalRead	(	void *	SIDXdevice,
		int	port,
		int &	value
	)

Gets the digital input value.

Parameters

SIDXdevice	A handle value that references the open device context.
port	An integer value representing the index of the port.
value	A variable to receive an integer value representing the digital input value.

Returns

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

int SIDXDevicePortDigitalWrite	(	void *	SIDXdevice,
		int	port,
		int	value
	)

Sets the digital output bits to the values specified by the data parameter.

Parameters

SIDXdevice	A handle value that references the open device context.
port	An integer value representing the index of the port.
value	An integer value to be written to the digital outputs.

Returns

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

int SIDXDevicePortGetCount	(	void *	SIDXdevice,
		int &	count
	)

Obtains the I/O port count.

Parameters

SIDXdevice	A handle value that references the open device context.
count	A variable to receive an integer value representing the total count of I/O ports.

Returns

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

int SIDXDevicePortGetType	(	void *	SIDXdevice,
		int	port,
		SIDXPortType &	type
	)

Obtains the available port type for a given port index.

The type determines the I/O functions that are valid for the port to read and write.

Parameters

SIDXdevice	A handle value that references the open device context.
port	An integer value representing the index of the port.
type	A variable to receive a value corresponding to the port type.

Returns

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