Gx5733ModuleGetState

Applies To

GX5701, GX5702, GX5704

Purpose

Returns the Module’s State.

Syntax

Gx5733ModuleGetState (nHandle, nPort, pnState, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX5733 board.
nPort
SHORT
Module port 0 (GX5733_PORT0) only.
pnState
PSHORT
Return the Module State as follow:
0. GX5733_MODULE_STATE _HALT: The Module is in Halt state.
1. GX5733_MODULE_STATE_RUN: The Module is in Run state.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The function returns the current module state. Use this function in order to monitor the module’s state

Example

The following example returns module port 0 state:

 

SHORT nState, nStatus;

Gx5733ModuleGetState (nHandle, GX5733_PORT0, &nState, &nStatus);

 

See Also

Gx5733ModuleRun, Gx5733ModuleHalt,Gx5733ModuleSetExtStrobePolarity,  Gx5733ModuleSetExtStrobeEnablePolarity, Gx5733ModuleSetStrobeSource,  Gx5733ModuleSetInternalStrobeSource