Gx5731ModuleGetState

Applies To

GX5701, GX5702, GX5704

Purpose

Returns the Module’s State.

Syntax

Gx5731ModuleGetState (nHandle, nPort, pnState, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX5731 board.
nPort
SHORT
Specified Module's port number:
0. GX5731_PORT0: Module port 0
1. GX5731_PORT1: Module port 1
2. GX5731_PORT2: Module port 2.   
pnState

PSHORT

Return the Module State as follow:
0. GX5731_MODULE_STATE _HALT: The Module is in Halt state.
1. GX5731_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;

Gx5731ModuleGetState (nHandle, GX5731_PORT0, &nState, &nStatus);

 

See Also

Gx5731ModuleRun, Gx5731ModuleHalt, Gx5731ModuleSetExtStrobePolarity, Gx5731ModuleSetExtStrobeEnablePolarity, Gx5731ModuleSetStrobeSource, Gx5731ModuleSetInternalStrobeSource