GtDio6xTimerGetPauseResumeModifierDelay

Applies To

GX5961, GX5964, File

Purpose

Returns the pause resume modifier delay timer value.

Syntax

GtDio6xTimerGetPauseResumeModifierDelay (nHandle, pnPauseResumeModifierTimer, pdDelay, 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.
nPauseResumeModifierTimer
SHORT
Used to select Pause Resume Modifier Timer to set:

0.    GTDIO6X_TIMER_PAUSE_RESUME_MODIFIER_DELAY0: Timer pause resume modifier delay 0.

1.    GTDIO6X_TIMER_PAUSE_RESUME_MODIFIER_DELAY1: Timer pause resume modifier delay 1.
pdDelay
PDOUBLE
Used to return the specified timer delay. The timer is programmed in 10ns steps (may have an additional 10ns of accuracy) with a range of 20ns to 42.949672970s.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

The vector delay is enabled using the GtDio6xStepSetPauseResumeTrigger API. The timer will start when the Pause starts. The vector delay timer generates a Resume when the timer times out.

See the GtDio6xStepSetPauseResumeTrigger API for more details.

Example

The following example timer pause resume modifier delay 0 to 100nSec delay, and returns the settings:

 

SHORT nStatus;

DOUBLE dDelay;

 

GtDio6xTimerSetPauseResumeModifierDelay (nHandle, GTDIO6X_TIMER_PAUSE_RESUME_MODIFIER_DELAY0, 100, &nStatus);

GtDio6xTimerGetPauseResumeModifierDelay (nHandle, GTDIO6X_TIMER_PAUSE_RESUME_MODIFIER_DELAY0, &dDelay, &nStatus);

 

See Also

GtDio6xTimerSetPauseResumeModifierDelay, GtDio6xStepSetPauseResumeTrigger, GtDio6xSequencerRun, GtDio6xSequencerStop, GtDio6xSequencerHalt, GtDio6xGetErrorString