GtDio6xSequencerGetStopMode

Applies To

GX5961, GX5964, File

Purpose

Returns the sequencer stop state mode.

Syntax

GtDio6xSequencerGetStopMode (nHandle, pnMode, 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.

●     File handle is used when communicating with a file. The File handle session identifier is  returned by calling GtDio6xFileOpen.
pnStopMode
PSHORT
Used to return the stop state mode, the stop mode determines what action a software generated stop or an external trigger will perform as follows:

0.    GTDIO6X_STOP_MODE_DISABLE: Stop Disabled, stop signal will be ignored.

1.    GTDIO6X_STOP_MODE_VECTOR: Stop at the next Vector. The stop signal can cause the current sequence burst to terminate at the end of the next vector.

2.    GTDIO6X_STOPEMODE_LOOP: Break out of loop and continue to the next Step. The stop signal can cause the next jump to be ignored. Sequence execution will continue at the step following the jump step.

3.    GTDIO6X_STOP_MODE_STEP: Stop at the next Step. The stop signal can cause the current sequence burst to terminate at the end of the sequence of a continuous or looped burst.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

The stop modes determine if and how the sequencer will stop once it receives either a software or hardware stop command.

The GtDio6xTrigConfigSetStopTrigger API causes the sequencer to stop based on the current stop mode. Use the GtDio6xSequencerSetStopMode API to program the stop mode.

The GtDio6xSequencerStop API stops the sequencer based on the GtDio6xSequencerSetStopMode API selection. The sequencer standby or idle state will be active based on the GtDio6xSequencerSetRunCompletionMode API setting.

Note: calling GtDio6xSequencerStop API when the sequencer is not active latches the GtDio6xTrigConfigSetStopTrigger command until the sequencer is active.

Example

The following example sets the sequencer and stop mode to stop at the next Vector, and returns the settings.

 

SHORT nStopMode, nStatus;

GtDio6xSequencerSetStopMode (nHandle, GTDIO6X_STOP_MODE_VECTOR, &nStatus);

GtDio6xSequencerGetStopMode (nHandle, &nStopMode, &nStatus);

 

See Also

GtDio6xSequencerSetHaltMode, GtDio6xSequencerSetStopMode, GtDio6xSequencerHalt, GtDio6xSequencerStop, GtDio6xGetErrorString