GtDio6xSequencerArm

Applies To

GX5296, GX5961, GX5964

Purpose

Arms the specified Step for an external trigger.

Syntax

GtDio6xSequencerArm (nHandle, lStep, 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.

lStep
LONG
Used to specify the sequence step number to arm. 0-4095.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

This function primes the sequencer and all of its components in order to get the sequencer ready to run by either issuing an external trigger or software trigger.

In case of issuing a software trigger, the GtDio6xSequencerRun API may be used.

Example

The following example arms sequence step 0:

 

SHORT nStatus

 

GtDio6xArm(nHandle, 0, &nStatus);

 

See Also

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