GtDio6xChannelGetAuxiliaryCount

Applies To

GX5961, GX5964

Purpose

Returns the number of auxiliary channels in the Domain.

Syntax

GtDio6xChannelGetAuxiliaryCount (nHandle, plChannelCount, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Session identifier:
  • Board handle is used when communicating with the hardware. The Board handle session identifier is returned by calling GtDio6xInitialize or GtDio6xSetupInitialization.
plChannelAuxCount
PLONG
Gets the number of auxiliary channels in the Domain.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

GX5296:

This function gets the number of auxiliary channels in the Domain. Each GX5296 board has 4 auxiliary channels, which are fully programmable. Only the Master board can use the auxiliary channels to control the sequencer, use the GtDio6xChannelSetAuxiliaryOutputSignal API. Slave boards can use the 4 auxiliary channels for PMU functionality.

GX5961:

This function gets the number of auxiliary channels in the Domain. Only GX5961 boards have auxiliary channel. Each GX5961 board has 4 channels, which are fully programmable, and an additional 8 channels which are simple I/O. Usually a domain has a single GX5961 board installed. All the channel API functions can be used with the first four auxiliary channels while the latter 8 auxiliary channels can only be used by GtDio6xChannelSetConnect and GtDio6xChannelSetAuxiliaryOutputSignal.

GX5964:

Does not have Auxiliary channels.

Example

The following gets the Domain auxiliary channel count.

 

SHORT nStatus;

LONG   lChannelAuxCount;

 

GtDio6xChannelGetAuxiliaryCount(nHandle, &lChannelAuxCount, &nStatus);

printf(“The number of auxiliary channels is: %d”, lChannelAuxCount);

 

See Also

GtDio6xChannelGetCount, GtDio6xChannelGetAuxiliaryOutputSignal, GtDio6xGetErrorString