GtDio6xSequencerStop

Applies To

GX5296, GX5961, GX5964

Purpose

Stops the sequencer.

Syntax

GtDio6xSequencerStop (nHandle, 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.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

This function generates a stop command to the sequencer.

The stop mode must be set prior to calling the GtDio6xSequencerSetStopMode API.

The Stop command stops the primary sequence based on the Stop Mode selection.  The standby or idle state will be active based on the Finish Mode setting (GtDio6xSequencerSetRunCompletionMode API). Commanding a stop when the primary sequence is not active, latches the stop command until the primary sequence is active.

Example

The following example stops the sequencer:

 

SHORT nStatus;

 

GtDio6xSequencerStop(nHandle, &nStatus);

 

See Also

GtDio6xSequencerSetStopMode, GtDio6xSequencerGetChannelsCompareTrigger, GtDio6xSequencerSetRunCompletionMode, GtDio6xSequencerSetIdleStep, GtDio6xSequencerRun, GtDio6xSequencerRunEx, GtDio6xSequencerHalt, GtDio6xSequencerResume, GtDio6xGetErrorString