GtDio6xPowerSupplyGetState

Applies To

GX5961, GX5964

Purpose

Returns the high-powered chassis power supply state.

Syntax

GtDio6xPowerSupplyGetState (nHandle, pnState, 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.
pnState
PSHORT
Used to get the high-powered chassis power supply state:

0.    GTDIO6X_POWER_SUPPLY_DISABLE: high-powered chassis power supply is disabled.

1.    GTDIO6X_POWER_SUPPLY_ENABLE: high-powered chassis power supply is enabled.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

This function is used to prime the sequencer prior to an external start.

Example

 

See the GtDio6xPowerSupplySetRailsVoltage for a complete example.

 

See Also

GtDio6xPowerSupplyIsSupported, GtDio6xPowerSupplyResetFault, GtDio6xPowerSupplySetVoltage, GtDio6xPowerSupplySetState,  GtDio6xPowerSupplySetVoltageRails, GtDio6xGetErrorString