niFgen_ConfigureSynchronization

NI-FGEN C Function

niFgen_ConfigureSynchronization

ViStatus niFgen_ConfigureSynchronization (ViSession vi, ViConstString channelName, ViInt32 synchronizationSource);

Purpose

Sets the signal generator to receive a synchronization signal to synchronize two or more NI 5401/5411/5431 signal generators. One signal generator should route a SYNC signal to a RTSI line by calling the niFgen_ExportSignal function (use the niFgen_RouteSignalOut function for the NI 5404), and other signal generators should receive the signal by calling the niFgen_ConfigureSynchronization function.

Note   The signal generator must not be in the Generating state when you call this function.

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session.
channelName ViConstString Specifies the channel name for which you want to configure the synchronization signal.

Default Value: "0"

synchronizationSource ViInt32 Specify the source of the synchronization signal you want to use.

Defined Values

NIFGEN_VAL_NONE   No synchronization source
NIFGEN_VAL_RTSI_0   RTSI 0 or PXI_Trig 0
NIFGEN_VAL_RTSI_1   RTSI 1 or PXI_Trig 1
NIFGEN_VAL_RTSI_2   RTSI 2 or PXI_Trig 2
NIFGEN_VAL_RTSI_3   RTSI 3 or PXI_Trig 3
NIFGEN_VAL_RTSI_4   RTSI 4 or PXI_Trig 4
NIFGEN_VAL_RTSI_5   RTSI 5 or PXI_Trig 5
NIFGEN_VAL_RTSI_6   RTSI 6 or PXI_Trig 6
NIFGEN_VAL_TTL0   TTL 0
NIFGEN_VAL_TTL1   TTL 1
NIFGEN_VAL_TTL2   TTL 2
NIFGEN_VAL_TTL3   TTL 3
NIFGEN_VAL_TTL4   TTL 4
NIFGEN_VAL_TTL5   TTL 5
NIFGEN_VAL_TTL6   TTL 6

Default Value: NIFGEN_VAL_NONE

Return Value

Name Type Description
Status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred. To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors