GtDio6xSequencerGetSyncPulseSource

Applies To

GX5296, GX5961, GX5964, File

Purpose

Returns the sequencer sync pulse source settings.

Syntax

GtDio6xSequencerGetSyncPulseSource (nHandle, nSyncOutput, pnEvenMode, pnStepNumber, 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.
nSyncOutput
SHORT
Selects the Sync Output Signal to set:

0.  GTDIO6X_SEQUENCER_SYNC_OUTPUT_1: First sequencer sync output signal.

1.  GTDIO6X_SEQUENCER_SYNC_OUTPUT_2: Second sequencer sync output signal.
pnEventMode
PSHORT
Used to return the sync output’s event mode:

0.    GTDIO6X_SEQUENCER_SYNC_ON_START: The sync pulse begins from the start of the burst.

1.    GTDIO6X_SEQUENCER_SYNC_ON_STEP_NUMBER: The sync pulse begins from the specified step number.
pnStepNumber
PSHORT
Used to return the sequence step number that is associated with the sync output.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

The sequencer has two sync outputs that can be routed to any of the AUX or PXI outputs as well as a source to the GtDio6xSequencerSetHaltMode API.

The sync pulse event can be set to either the start of a sequence or a specific step.

The Sync pulse can be used to set up a break point at a particular data vector. See GtDio6xSequencerSetSyncPulseParameters for more information.

Example

The following example sets the Sync 2 event mode to start on step number 5, and returns the settings:

 

SHORT nEventMode, nStepNumber;

SHORT nStatus;

 

GtDio6xSequencerSetSyncPulseSource(nHandle, GTDIO6X_SEQUENCER_SYNC_OUTPUT_2, GTDIO6X_SEQUENCER_SYNC_ON_STEP_NUMBER 5, &nStatus);

GtDio6xSequencerGetSyncPulseSource(nHandle, GTDIO6X_SEQUENCER_SYNC_OUTPUT_2, &nEventMode, &nStepNumber, &nStatus);

 

See Also

GtDio6xSequencerSetSyncPulseSource, GtDio6xSequencerSetSyncPulseParameters, GtDio6xSequencerGetSyncPulseParameters, GtDio6xGetErrorString