niFgen_ConfigureSynchronization
- Updated2023-02-21
- 2 minute(s) read
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.
 |
Notes The signal generator must not be in the Generating state when you call this function. Only the NI 5401/5411/5431 signal generators require this function to be called for proper synchronization. |
Parameters
| Input | ||||||||||||||||||||||||||||||||
| Name | Type | Description | ||||||||||||||||||||||||||||||
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init, niFgen_InitWithOptions, or niFgen_InitializeWithChannels 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
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:
|