GtDio6xTimerSetSequencerTimeout

Applies To

GX5961, GX5964, File

Purpose

Sets the sequence timeout value and output drivers’ states.

Syntax

GtDio6xTimerSetSequencerTimeout  (nHandle, dTimeoutValue, nState, 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.

dTimeoutValue
DOUBLE
Sets timeout, timeout is programmed in 20ns steps (may have an additional 20ns of error) with a range of 40ns to 85.899345940s.
nState
SHORT
Used to specify if the timer’s timeout will affect the output drivers or not.

0.    GTDIO6X_DISABLED: A Sequencer timeout will not affect the output drivers.

1.    GTDIO6X_ENABLED: A Sequencer timeout will cause all output drivers to will be disabled.

pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

This input control is used to specify the sequencer timeout count. The timeout timer will set bit 6 (WDTO) in the sequence event register if the sequence active time exceeds the specified value. The user can optionally disable the output drivers when the timeout status is true.

Example

The following example sets the timeout value of the sequence timer to 500nS, enables the output drivers disabled on timeout, and returns the settings:

 

SHORT nState;

SHORT nStatus;

DOUBLE dTimeoutValue;

 

GtDio6xSetSequencerTimer(nHandle, 500nS, GTDIO6X_ENABLED, &nStatus);

GtDio6xGetSequencerTimer(nHandle, &dTimeoutValue, &nState, &nStatus);

 

See Also

GtDio6xTimerGetSequencerTimeout, GtDio6xGetErrorString