niFgen_ExportSignal
ViStatus niFgen_ExportSignal (ViSession vi, ViInt32 signal, ViConstString signalIdentifier, ViConstString outputTerminal);
Purpose
Exports various signals, clocks, and events from the signal generator to the RTSI lines, front panel, or other external terminals.
 |
Notes The signal generator must not be in the Generating state when you call this function. |
|
You can clear a previously routed signal by exporting the signal to "" (empty string). |
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. |
| signal |
ViInt32 |
Specifies the source of the signal to route.
Defined Values
| NIFGEN_VAL_ONBOARD_REFERENCE_CLOCK | The onboard 10 MHz synchronization clock (PCI only) |
| NIFGEN_VAL_SYNC_OUT | The SYNC signal that normally appears on the SYNC OUT front panel connector |
| NIFGEN_VAL_START_TRIGGER | Start trigger |
| NIFGEN_VAL_MARKER_EVENT | Marker event |
| NIFGEN_VAL_SAMPLE_CLOCK_TIMEBASE | The clock from which the sample clock is derived |
| NIFGEN_VAL_SYNCHRONIZATION | A synchronization strobe used to guarantee absolute synchronization between two or more signal generators. (NI 5404, 5411, 5431 only) |
| NIFGEN_VAL_SAMPLE_CLOCK | Sample clock |
| NIFGEN_VAL_REFERENCE_CLOCK | PLL Reference clock |
| NIFGEN_VAL_SCRIPT_TRIGGER | Script trigger |
| NIFGEN_VAL_READY_FOR_START_EVENT | Ready For Start event |
| NIFGEN_VAL_STARTED_EVENT | Started event |
| NIFGEN_VAL_DONE_EVENT | Done event |
| NIFGEN_VAL_DATA_MARKER_EVENT | Data Marker event |
|
| signalIdentifier |
ViConstString |
Specifies which instance of the selected signal to export.
Defined Values
| "" (empty string) | Default (for non instance-based signals) |
| "ScriptTrigger0" | Script trigger 0 |
| "ScriptTrigger1" | Script trigger 1 |
| "ScriptTrigger2" | Script trigger 2 |
| "ScriptTrigger3" | Script trigger 3 |
| "Marker0" |
Marker 0 |
| "Marker1" |
Marker 1 |
| "Marker2" |
Marker 2 |
| "Marker3" |
Marker 3 |
| "DataMarker0" |
Data Marker 0 |
| "DataMarker1" |
Data Marker 1 |
| "DataMarker2" |
Data Marker 2 |
| "DataMarker3" |
Data Marker 3 |
|
| outputTerminal |
ViConstString |
Specifies the output terminal to export the signal.
|
Note The following Defined Values are examples of possible output terminals. For a complete list of the output terminals available on your device, refer to the Device Routes tab in MAX. |
Defined Values
| "" (empty string) | Do not export signal |
| "PFI0" | PFI line 0 |
| "PFI1" | PFI line 1 |
| "PFI4" | PFI line 4 |
| "PFI5" | PFI line 5 |
| "PXI_Trig0" |
PXI or RTSI line 0 |
| "PXI_Trig1" |
PXI or RTSI line 1 |
| "PXI_Trig2" |
PXI or RTSI line 2 |
| "PXI_Trig3" |
PXI or RTSI line 3 |
| "PXI_Trig4" |
PXI or RTSI line 4 |
| "PXI_Trig5" |
PXI or RTSI line 5 |
| "PXI_Trig6" |
PXI or RTSI line 6 |
| "PXI_Trig7" |
PXI or RTSI line 7 |
| "DDC_ClkOut" |
Clock out from DDC connector |
| "PXI_Star" | PXI Star trigger line |
|
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 |
|