GtDio6xTimerSetPauseResumeModifierTimeout

Applies To

GX5961, GX5964, File

Purpose

Sets the pause resume modifier timeout value.

Syntax

GtDio6xTimerSetPauseResumeModifierTimeout (nHandle, dTimeout, 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.

dTimeout
DOUBLE
The timeout is programmed in 10ns steps (may have an additional 10ns of error) with a range of 20ns to 42.949672970s.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

The pause resume modifier timeout is enabled using the GTDIO6X_PAUSE_RESUME_MODIFIER_TIMEOUT parameter in the GtDio6xStepSetPauseResumeTrigger API. The timeout timer will generate an event when the timer times out and the occurrence of this particular event can be enabled to generate an interrupt so the S/W can query the events to see which one occurred. The Pause will continue unless the termination condition is subsequently met, whereby execution will resume. If it doesn't, the user can manually Resume the Sequencer, or may then Stop the Sequencer.

Example

The following example sets the pause resume modifier timeout value to 100 nSec and returns the settings:

 

SHORT nStatus;

DOUBLE dDelay;

 

GtDio6xTimerSetPauseResumeModifierTimeout (nHandle, 100, &nStatus);

GtDio6xTimerGetPauseResumeModifierTimeout (nHandle, &dDelay, &nStatus);

 

See Also

GtDio6xStepSetPauseResumeTrigger, GtDio6xSequencerRun, GtDio6xSequencerRunEx, GtDio6xSequencerStop, GtDio6xSequencerHalt, GtDio6xGetErrorString