GX5296, GX5961, GX5964, File
Returns the sequencer Halt mode where execution will halt following either a manual halt (Halt command) or an external trigger.
GtDio6xSequencerGetHaltMode (nHandle, pnMode, pnStatus)
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. |
pnHaltStateMode |
PSHORT |
Returns the halt state mode as follows:0. GTDIO6X_HALT_MODE_DISABLE: Halt Disabled. 1. GTDIO6X_HALT_MODE_VECTOR: Halt the current step at the end of the next vector. 2. GTDIO6X_HALT_MODE_STEP: Halt the current step at the end of the next step. 3. GTDIO6X_HALT_MODE_BURST: Halt at the end of the current burst loop. 4. GTDIO6X_HALT_MODE_SYNC1: Halt the current step at the end of the next vector where sync pulse 1 is set. 5. GTDIO6X_HALT_MODE_SYNC2: Halt the current step at the end of the next vector where sync pulse 2 is set. 6. GTDIO6X_HALT_MODE_VECTOR_ERROR: Halt on Vector Error where a Vector Error occurred and the vector has its error flag set (Real Time Compare Error). Use GtDio6xWriteVectorTestFlagsMemory API to set the step’s Vector Test Flags Memory. 7. GTDIO6X_HALT_MODE_STEP_ERROR: Halt at the end of a step where a Vector Error occurred and the vector has its error flag set (Real Time Compare Error). Use GtDio6xWriteVectorTestFlagsMemory API to set the step’s Vector Test Flags Memory. 8. GTDIO6X_HALT_MODE_BURST_ERROR: Halt the current step at the end of the next vector where a Vector Error occurred and the vector has its error flag set (Real Time Compare Error). Use GtDio6xWriteVectorTestFlagsMemory API to set the step’s Vector Test Flags Memory. |
pnStatus |
PSHORT |
Returned status: 0 on success, negative value on failure. |
The halt mode determines where execution will halt following either a software generated halt or an external trigger.
The following example sets the sequencer pause and stop modes to Vector:
SHORT nPauseStateMode, nStopStateMode;
SHORT nStatus;
GtDio6xSequencerGetHaltMode(nHandle, &nMode, &nStatus);
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