ReadDescriptorProcs Struct Reference

The Read Descriptor Suite, handles all the Get functionality for scripting. More...

#include <PIActions.h>

Data Fields
int16	readDescriptorProcsVersion
	Version of the Read Descriptor Suite.
int16	numReadDescriptorProcs
	Number of routines in the Read Descriptor Suite.
OpenReadDescriptorProc	openReadDescriptorProc
	Function pointer to open a read descriptor.
CloseReadDescriptorProc	closeReadDescriptorProc
	Function pointer to close a read descriptor.
GetKeyProc	getKeyProc
	Function pointer to get a key from a descriptor.
GetIntegerProc	getIntegerProc
	Function pointer to get an integer value from a descriptor.
GetFloatProc	getFloatProc
	Function pointer to get a float value from a descriptor.
GetUnitFloatProc	getUnitFloatProc
	Function pointer to get a unit float value from a descriptor.
GetBooleanProc	getBooleanProc
	Function pointer to get a boolean value from a descriptor.
GetTextProc	getTextProc
	Function pointer to get a text value from a descriptor.
GetAliasProc	getAliasProc
GetEnumeratedProc	getEnumeratedProc
	Function pointer to get an enumeration from a descriptor.
GetClassProc	getClassProc
	Function pointer to get a class description type from a descriptor.
GetSimpleReferenceProc	getSimpleReferenceProc
	Function pointer to get a basic reference from a descriptor.
GetObjectProc	getObjectProc
	Function pointer to get an object from a descriptor.
GetCountProc	getCountProc
	Function pointer to get a count from a descriptor.
GetStringProc	getStringProc
	Function pointer to get an string value from a descriptor.
GetPinnedIntegerProc	getPinnedIntegerProc
	Function pointer to get a pinned integer value from a descriptor.
GetPinnedFloatProc	getPinnedFloatProc
	Function pointer to get a pinned float value from a descriptor.
GetPinnedUnitFloatProc	getPinnedUnitFloatProc
	Function pointer to get a pinned unit float value from a descriptor.

---

Detailed Description

The Read Descriptor Suite, handles all the Get functionality for scripting.

Make sure to check its version number and number of routines for compatibility before using its callbacks.

---

Field Documentation

int16 ReadDescriptorProcs::readDescriptorProcsVersion

Version of the Read Descriptor Suite.

int16 ReadDescriptorProcs::numReadDescriptorProcs

Number of routines in the Read Descriptor Suite.

OpenReadDescriptorProc ReadDescriptorProcs::openReadDescriptorProc

Function pointer to open a read descriptor.

CloseReadDescriptorProc ReadDescriptorProcs::closeReadDescriptorProc

Function pointer to close a read descriptor.

GetKeyProc ReadDescriptorProcs::getKeyProc

Function pointer to get a key from a descriptor.

GetIntegerProc ReadDescriptorProcs::getIntegerProc

Function pointer to get an integer value from a descriptor.

GetFloatProc ReadDescriptorProcs::getFloatProc

Function pointer to get a float value from a descriptor.

GetUnitFloatProc ReadDescriptorProcs::getUnitFloatProc

Function pointer to get a unit float value from a descriptor.

GetBooleanProc ReadDescriptorProcs::getBooleanProc

Function pointer to get a boolean value from a descriptor.

GetTextProc ReadDescriptorProcs::getTextProc

Function pointer to get a text value from a descriptor.

GetAliasProc ReadDescriptorProcs::getAliasProc

Deprecated:

Function pointer to get an alias value from a descriptor.

GetEnumeratedProc ReadDescriptorProcs::getEnumeratedProc

Function pointer to get an enumeration from a descriptor.

GetClassProc ReadDescriptorProcs::getClassProc

Function pointer to get a class description type from a descriptor.

GetSimpleReferenceProc ReadDescriptorProcs::getSimpleReferenceProc

Function pointer to get a basic reference from a descriptor.

GetObjectProc ReadDescriptorProcs::getObjectProc

Function pointer to get an object from a descriptor.

GetCountProc ReadDescriptorProcs::getCountProc

Function pointer to get a count from a descriptor.

GetStringProc ReadDescriptorProcs::getStringProc

Function pointer to get an string value from a descriptor.

GetPinnedIntegerProc ReadDescriptorProcs::getPinnedIntegerProc

Function pointer to get a pinned integer value from a descriptor.

GetPinnedFloatProc ReadDescriptorProcs::getPinnedFloatProc

Function pointer to get a pinned float value from a descriptor.

GetPinnedUnitFloatProc ReadDescriptorProcs::getPinnedUnitFloatProc

Function pointer to get a pinned unit float value from a descriptor.

---

The documentation for this struct was generated from the following file:

• PIActions.h