GtDio6xTimerGetStepTimeout

Applies To

GX5961, GX5964, File

Purpose

Returns the global step timeout value and state settings.

Syntax

GtDio6xTimerGetStepTimeout (nHandle, pdTimeout, pnState, 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.
pdTimeout
PDOUBLE
The timeout is programmed in 10ns steps (may have an additional 10ns of error) with a range of 20ns to 42.949672970s.
pnState
PSHORT
Returns the timeout state:

0.    GTDIO6X_DISABLED: timeout disabled.

1.    GTDIO6X_ENABLED: timeout enabled.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

This function programs the sequence timeout value and state. The sequence timer restarts at the beginning of every sequence step.  The restart can be disabled using the STO Continue flag in the GtDio6xStepSetOutputFlag function. 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 the global step timeout value to 10 sec and enable the timeout and returns the settings:

 

SHORT nStatus,nState;

DOUBLE dTimeout;

 

GtDio6xTimerSetStepTimeout (nHandle, 10e9, GTDIO6X_ENABLED, &nStatus);

GtDio6xTimerGetStepTimeout (nHandle, &dTimeout, &nState, &nStatus);

 

See Also

GtDio6xStepSetPauseResumeTrigger, GtDio6xSequencerRun, GtDio6xSequencerRunEx, GtDio6xSequencerStop, GtDio6xSequencerHalt, GtDio6xGetErrorString