GtDio6xSequencerArmIdleStep

Applies To

GX5296, GX5961, GX5964

Purpose

Arms the specified Idle Step.

Syntax

GtDio6xSequencerArmIdleStep (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 user has to prime the sequencer to run the pre-defined Idle step (GtDio6xSequencerSetIdleStep API) prior to software trigger (GtDio6xSequencerRunIdleStep API) or external trigger.

Before running a sequence of steps, the user needs to set the sequencer’s finish step by calling GtDio6xSequencerSetRunCompletionMode API. When execution of sequence of steps completes, the sequencer will enter either the Standby or Idle state. The Standby state outputs the first pattern of the specified step and pattern memory can be accessed by the user. The Idle state will output the entire pattern set of the specified step and pattern memory cannot be accessed.

Example

The following example arms sequence step 0:

 

SHORT nStatus

 

GtDio6xSequencerArmIdleStep(nHandle, &nStatus);

See Also

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