GtDio6xSequencerSetIdleStep

Applies To

GX5961, GX5964, File

Purpose

Sets the sequencer idle step number.

Syntax

GtDio6xSequencerSetIdleStep (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.

     File handle is used when communicating with a file. The File handle session identifier is  returned by calling GtDio6xFileOpen.

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

Comments

This function is used to set the sequencer idle step number. The idle step can be run explicitly by calling GtDio6xSequencerRunIdleStep API.

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.

Example

The following example Sets the sequencer idle step number to 0, and returns the settings:

 

SHORT nStep, nStatus;

LONG lStep;

 

GtDio6xSequencerSetIdleStep (nHandle, 0, &nStatus);

GtDio6xSequencerGetIdleStep (nHandle, &lStep, &nStatus);

 

See Also

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