GtDio6xTimerSetStepTimeoutMode

Applies To

GX5296, GX5961, GX5964, File

Purpose

Set the specified step timeout mode settings.

Syntax

GtDio6xTimerSetStepTimeout (nHandle, lStep, nMode, 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 sequence step number to arm. 0-4095.
nMode
SHORT
Set the specified timeout mode:

0.    GTDIO6X_TIMER_STEP_TIMEOUT_MODE_PER_STEP: The sequence timeout resets at the beginning of each sequence step during a burst.

1.    GTDIO6X_TIMER_STEP_TIMEOUT_MODE_ACCUMULATE: The sequence timeout will not reset at the beginning of each sequence step during a burst.  By enabling this flag the sequence timeout will continue from its previous value (accumulate) during this step.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

This function specifies the timeout continue flag level for the specified sequence step. The sequence timeout resets at the beginning of each sequence step during a burst. By enabling this flag the sequence timeout will continue from its previous value (accumulate) during this step.

The sequence timer restarts at the beginning of every sequence step.  The restart can be disabled using the STO Continue flag . If the state is enabled, a sequence timeout will set bit 7 (STO) in the sequence event register. The timeout is programmed in 10ns steps (may have an additional 10ns of error) with a range of 20ns to 42.949672970s.

Example

The following example sets step 5 timeout mode to continue from its previous value (accumulate) during this step and returns the settings:

 

SHORT nStatus, nMode;

 

GtDio6xTimerSetStepTimeout (nHandle, 5, GTDIO6X_TIMER_STEP_TIMEOUT_MODE_ACCUMULATE, &nStatus);

GtDio6xTimerGetStepTimeout (nHandle, 5, &nMode, &nStatus);

 

See Also

GtDio6xStepSetPauseResumeTrigger, GtDio6xSequencerRun, GtDio6xSequencerStop, GtDio6xSequencerHalt, GtDio6xGetErrorString