GtDio6xSequencerHalt

Applies To

GX5296, GX5961, GX5964

Purpose

Generates a halt command to the sequencer.

Syntax

GtDio6xSequencerHalt (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

The pause mode must be set before calling this function, use GtDio6xSequencerSetHaltMode API.

Calling this function generates a software Halt command.

Example

The following example sets the halt mode to halt the sequencer at the next vector and then issues a software generated halt:

 

SHORT nStatus;

 

GtDio6xSequencerSetHaltMode (nHandle, GTDIO6X_HALT_MODE_VECTOR, &nStatus);

GtDio6xSequencerHalt(nHandle, &nStatus);

 

See Also

GtDio6xSequencerArm, GtDio6xSequencerArmIdleStep, GtDio6xSequencerHalt, GtDio6xSequencerReset, GtDio6xSequencerResume, GtDio6xSequencerRun, GtDio6xSequencerRunEx, GtDio6xSequencerRunIdleStep, GtDio6xSequencerSetBurstCount, GtDio6xSequencerSetChannelsCompareTrigger, GtDio6xSequencerSetRunCompletionMode, GtDio6xSequencerSetFreqSynth, GtDio6xSequencerSetHaltMode, GtDio6xSequencerSetIdleStep, GtDio6xSequencerSetLoopCounterMode, GtDio6xSequencerSetMasterClockSource, GtDio6xSequencerSetRecordOffset, GtDio6xSequencerSetRecordParameters, GtDio6xSequencerSetStopMode, GtDio6xSequencerSetSyncPulseSource, GtDio6xSequencerSetSyncPulseParameters, GtDio6xSequencerSetSystemClockExternal, GtDio6xSequencerSetSystemClockSource, GtDio6xSequencerStop, GtDio6xGetErrorString