SIDX 7
Functions
SIDXDevice.h File Reference

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

#include "SIDXConstants.h"

Go to the source code of this file.

Functions

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

Detailed Description

File containing SIDX device usage for reference.

Function Documentation

SIDXDeviceActionDo ( integer  SIDXdevice,
integer  setting,
string  command,
integer  status 
)

Perform a device-specific action.

Parameters
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the handle for the action.
commandA 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.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceActionGetByItem ( integer  SIDXdevice,
integer  index,
integer  setting,
integer  status 
)

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

Parameters
SIDXdeviceA handle value that references the open device context.
indexAn integer index of the action within the actions available for the camera. The first action available for the camera has index zero.
settingA 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.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceActionGetByName ( integer  SIDXdevice,
string  name,
integer  setting,
integer  status 
)

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

Parameters
SIDXdeviceA handle value that references the open device context.
nameA text string containing the action name.
settingA 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.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceActionGetCount ( integer  SIDXdevice,
integer  count,
integer  status 
)

Obtain the total count of device-specific actions.

Parameters
SIDXdeviceA handle value that references the open device context.
countA 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.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceActionGetName ( integer  SIDXdevice,
integer  index,
string  name,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
indexAn integer index of the action within the actions available for the camera. The first action available for the camera has index zero.
nameA variable to receive a text string representing the action name.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceDriverGetDescription ( integer  SIDXdevice,
string  description,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
descriptionA variable to receive a text string description representing the driver. This description is intended for reporting to the user.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceDriverGetName ( integer  SIDXdevice,
string  name,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
nameA variable to receive a text string name representing the driver.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceDriverGetType ( integer  SIDXdevice,
integer  type,
integer  status 
)

Obtain the device vendor and device driver.

Parameters
SIDXdeviceA handle value that references the open device context.
typeA variable to receive a value describing the device vendor and device driver type.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraBooleanGet ( integer  SIDXdevice,
integer  setting,
integer  value,
integer  status 
)

Obtain the value of a device-specific setting.

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

Parameters
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueA variable to receive a boolean value representing the current setting.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraBooleanSet ( integer  SIDXdevice,
integer  setting,
integer  value,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueA boolean value to set.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraGetByItem ( integer  SIDXdevice,
integer  item,
integer  setting,
integer  status 
)

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

Parameters
SIDXdeviceA handle value that references the open device context.
itemAn integer value containing the item of the device-specific setting. The first setting has item zero.
settingA 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.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraGetByName ( integer  SIDXdevice,
string  name,
integer  setting,
integer  status 
)

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

Parameters
SIDXdeviceA handle value that references the open device context.
nameA text string containing the setting name.
settingA 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.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraGetCount ( integer  SIDXdevice,
integer  count,
integer  status 
)

Obtain the total count of device-specific settings.

Parameters
SIDXdeviceA handle value that references the open device context.
countA 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.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraGetLabel ( integer  SIDXdevice,
integer  setting,
string  label,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
labelA 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.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraGetName ( integer  SIDXdevice,
integer  item,
string  name,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
itemAn integer value containing the item of the device-specific setting. The first setting has item zero.
nameA variable to receive a text string representing the setting name.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraGetType ( integer  SIDXdevice,
integer  setting,
integer  type,
integer  status 
)

Obtain the type of a device-specific setting.

Parameters
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
typeA variable to receive a value describing the type of the device-specific setting. If the handle is not valid, the setting type is none.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraGetUnit ( integer  SIDXdevice,
integer  setting,
string  unit,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
unitA 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.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraGetValueLocal ( integer  SIDXdevice,
integer  setting,
string  description,
integer  status 
)

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

Parameters
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
descriptionA variable to receive a text string description of the current value of the setting.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraIntegerGet ( integer  SIDXdevice,
integer  setting,
integer  value,
integer  status 
)

Obtain the value of a device-specific setting.

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

Parameters
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueA variable to receive an integer value representing the setting value.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraIntegerGetRange ( integer  SIDXdevice,
integer  setting,
integer  minimum,
integer  maximum,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
minimumA variable to receive an integer value representing the minimum limit.
maximumA variable to receive an integer value representing the maximum limit.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraIntegerGetValue ( integer  SIDXdevice,
integer  setting,
integer  value,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueA variable to receive an integer value representing the setting value used by the camera.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraIntegerSet ( integer  SIDXdevice,
integer  setting,
integer  value,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueThe integer value to set. The value must be valid for the setting.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraIsSettable ( integer  SIDXdevice,
integer  setting,
integer  settable,
integer  status 
)

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

Parameters
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
settableA variable to receive a boolean value to determine whether the setting parameter is settable.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraListGet ( integer  SIDXdevice,
integer  setting,
integer  index,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
indexA variable to receive an integer value representing the index of the entry in the setting list.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraListGetCount ( integer  SIDXdevice,
integer  setting,
integer  count,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
countA 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.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraListGetEntry ( integer  SIDXdevice,
integer  setting,
integer  index,
double  entry,
integer  status 
)

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

Parameters
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
indexAn integer index of the setting within the setting list. The first index in the setting list has index zero.
entryA variable to receive a real (floating-point) value representing the entry associated with the specific index.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraListGetLocal ( integer  SIDXdevice,
integer  setting,
integer  index,
string  description,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
indexAn integer index of the setting within the setting list. The first index in the setting list has index zero.
descriptionA variable to receive a text string description of the specific index.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraListGetValue ( integer  SIDXdevice,
integer  setting,
double  value,
integer  status 
)

Obtain the value of a device-specific setting.

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

Parameters
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueA 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.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraListSet ( integer  SIDXdevice,
integer  setting,
integer  index,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
indexAn integer index of the setting within the setting list. The first entry in the setting list has index zero.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraListSetValue ( integer  SIDXdevice,
integer  setting,
double  value,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueA real (floating-point) value to set. The value must be valid for the setting. The value is device-specific.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraRealGet ( integer  SIDXdevice,
integer  setting,
double  value,
integer  status 
)

Obtain the value of a device-specific setting.

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

Parameters
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueA variable to receive a real (floating-point) value representing the current setting value.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraRealGetRange ( integer  SIDXdevice,
integer  setting,
double  minimum,
double  maximum,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
minimumA variable to receive a real (floating point) value representing the minimum limit.
maximumA variable to receive a real (floating point) value representing the maximum limit.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraRealGetValue ( integer  SIDXdevice,
integer  setting,
double  value,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueA variable to receive a real (floating-point) value representing the setting value used by the device.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraRealSet ( integer  SIDXdevice,
integer  setting,
double  value,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueThe real (floating-point) value to set.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraSequenceGet ( integer  SIDXdevice,
integer  setting,
integer *  value,
integer  length,
integer  return_length,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueA variable to receive an array of integer value representing the current setting.
lengthThe length of the array, in units of entries. This is the maximum number of entries that can be written into the array.
return_lengthAn integer variable to receive the length of the array, in units of entries.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraSequenceGetSize ( integer  SIDXdevice,
integer  setting,
integer  size,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
sizeA variable to receive an integer value representing the size of the array length, measured in units of integer, for the setting.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraSequenceSet ( integer  SIDXdevice,
integer  setting,
integer *  value,
integer  length,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueAn array of integer value to set.
lengthThe length of the array, in units of entries. This is the maximum number of entries that can be written into the array
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraStringGet ( integer  SIDXdevice,
integer  setting,
string  value,
integer  status 
)

Obtain the value of a device-specific setting.

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

Parameters
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueA variable to receive a text string value representing the current setting.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceExtraStringSet ( integer  SIDXdevice,
integer  setting,
string  value,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
settingAn integer value containing the setting identifier.
valueA text string value to set.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceGetDescription ( integer  SIDXdevice,
string  description,
integer  status 
)

Obtain a description of the device.

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

Parameters
SIDXdeviceA handle value that references the open device context.
descriptionA variable to receive a text string description of the device.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceGetLabel ( integer  SIDXdevice,
string  label,
integer  status 
)

Obtain a human readable label representing the device.

Parameters
SIDXdeviceA handle value that references the open device context.
labelA variable to receive a text string label representing the device.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDeviceGetLastError ( integer  SIDXdevice,
string  message 
)

The function translates the error code into a text string.

Parameters
SIDXdeviceA handle value that references the open device context.
messageA text string to receive the text associated with the last error occurred.
SIDXDeviceGetName ( integer  SIDXdevice,
string  name,
integer  status 
)

Obtain the name of the device.

Parameters
SIDXdeviceA handle value that references the open device context.
nameA variable to receive a text string name representing the device.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDevicePortAnalogGetRange ( integer  SIDXdevice,
integer  port,
double  minimum,
double  maximum,
integer  status 
)

Obtain the minimum and maximum analogue output voltage values.

Parameters
SIDXdeviceA handle value that references the open device context.
portAn integer value representing the index of the port.
minimumA variable to receive a real (floating point) value representing the minimum limit, in Volt.
maximumA variable to receive a real (floating point) value representing the maximum limit, in Volt.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDevicePortAnalogRead ( integer  SIDXdevice,
integer  port,
double  voltage,
integer  status 
)

Obtains the voltage on the specified port.

Parameters
SIDXdeviceA handle value that references the open device context.
portAn integer value representing the index of the port.
voltageA variable to receive a real (floating-point) value representing the input voltage, in Volt.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDevicePortAnalogWrite ( integer  SIDXdevice,
integer  port,
double  voltage,
integer  status 
)

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

Parameters
SIDXdeviceA handle value that references the open device context.
portAn integer value representing the index of the port.
voltageA real (floating-point) value representing the output voltage, in Volt.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDevicePortBitRead ( integer  SIDXdevice,
integer  port,
integer  asserted,
integer  status 
)

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

Parameters
SIDXdeviceA handle value that references the open device context.
portAn integer value representing the index of the port.
assertedA variable to receive a boolean value, true if asserted, false otherwise.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDevicePortBitWrite ( integer  SIDXdevice,
integer  port,
integer  asserted,
integer  status 
)

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

Parameters
SIDXdeviceA handle value that references the open device context.
portAn integer value representing the index of the port.
assertedA boolean value, true if the specified output bit is asserted. False if the specified output bit is de-asserted.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDevicePortDigitalRead ( integer  SIDXdevice,
integer  port,
integer  value,
integer  status 
)

Gets the digital input value.

Parameters
SIDXdeviceA handle value that references the open device context.
portAn integer value representing the index of the port.
valueA variable to receive an integer value representing the digital input value.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDevicePortDigitalWrite ( integer  SIDXdevice,
integer  port,
integer  value,
integer  status 
)

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

Parameters
SIDXdeviceA handle value that references the open device context.
portAn integer value representing the index of the port.
valueAn integer value to be written to the digital outputs.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDevicePortGetCount ( integer  SIDXdevice,
integer  count,
integer  status 
)

Obtains the I/O port count.

Parameters
SIDXdeviceA handle value that references the open device context.
countA variable to receive an integer value representing the total count of I/O ports.
statusNon-zero if the function failed, zero if it succeeded.
SIDXDevicePortGetType ( integer  SIDXdevice,
integer  port,
integer  type,
integer  status 
)

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
SIDXdeviceA handle value that references the open device context.
portAn integer value representing the index of the port.
typeA variable to receive a value corresponding to the port type.
statusNon-zero if the function failed, zero if it succeeded.