Getting Started

SDK API Reference

SDK API Features

Other Documentation

PIDescriptorParameters Struct Reference
[Descriptor Suite Callbacks (DEPRECATED Standard Suite)]

#include <PIActions.h>

Detailed Description

Descriptor suite callbacks.

The suite is divided into two sub-suites, one for read, one for write, that define the set of available routines for the Descriptor Suite.


Data Fields

int16 descriptorParametersVersion
 Minimum version required to process structure.
int16 playInfo
 Flags for playback.
int16 recordInfo
 Flags for recording.
PIDescriptorHandle descriptor
 Handle to actual descriptor key/value pairs.
WriteDescriptorProcs * writeDescriptorProcs
 WriteDescriptorProcs sub-suite.
ReadDescriptorProcs * readDescriptorProcs
 ReadDescriptorProcs sub-suite.

Field Documentation

int16 PIDescriptorParameters::descriptorParametersVersion

Minimum version required to process structure.

int16 PIDescriptorParameters::playInfo

Flags for playback.

See flags for record and playback.

int16 PIDescriptorParameters::recordInfo

Flags for recording.

See flags for record and playback.

PIDescriptorHandle PIDescriptorParameters::descriptor

Handle to actual descriptor key/value pairs.

WriteDescriptorProcs* PIDescriptorParameters::writeDescriptorProcs

WriteDescriptorProcs sub-suite.

ReadDescriptorProcs* PIDescriptorParameters::readDescriptorProcs

ReadDescriptorProcs sub-suite.

Handles all the Get functionality for scripting.

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