DioPowerSupplyGetRailsState

Applies To

GX5055

Purpose

Returns the high powered chassis power supply state.

Syntax

DioPowerSupplyGetRailsState (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 DioInitialize or DioSetupInitialization.
pnState
PSHORT
Used to get the high powered chassis power supply state
0.     DIO_POWER_SUPPLY_DISABLE: high powered chassis power supply is disabled.
1.   DIO_POWER_SUPPLY_ENABLE: high powered chassis power supply is enabled
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

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

Example

See the DioPowerSupplySetRailsVoltage for a complete example.

 

See Also

DioPowerSupplyGetStatus, DioPowerSupplyIsSupported, DioPowerSupplyMeasure, DioPowerSupplyResetFault, DioPowerSupplySetRailsState, DioPowerSupplySetRailsVoltage, DioGetErrorString