niRFSG_ExportSignal

NI-RFSG C Function

previous page next page

niRFSG_ExportSignal

C Function Prototype

ViStatus niRFSG_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. The NI-RFSG device must be in the Configuration state before you call this function.

You can clear a previously routed signal by exporting the signal to " " (empty string).

Supported Devices: NI 5650/5651/5652/5670/5671/5672

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.

Default Value: None
signal ViInt32 Specifies the signal to route.
  • Onboard reference clock output terminal is not configurable on the NI 5670/5671/5672 device.
  • Triggers and Marker events are not available on the NI 5650/5651/5652 device.


Defined Values:
NIRFSG_VAL_START_TRIGGERStart trigger
NIRFSG_VAL_SCRIPT_TRIGGERScript trigger
NIRFSG_VAL_MARKER_EVENTMarker event
NIRFSG_VAL_REF_CLOCKThe onboard 10 MHz synchronization clock (PCI chassis only)

Default Value: NIRFSG_VAL_START_TRIGGER

signalIdentifier ViConstString Specifies which instance of the selected signal to export.

Defined Values:
NIRFSG_VAL_SCRIPT_TRIGGER0Script trigger 0
NIRFSG_VAL_SCRIPT_TRIGGER1Script trigger 1
NIRFSG_VAL_SCRIPT_TRIGGER2Script trigger 2
NIRFSG_VAL_SCRIPT_TRIGGER3Script trigger 3
NIRFSG_VAL_MARKER_EVENT0 Marker 0
NIRFSG_VAL_MARKER_EVENT1Marker 1
NIRFSG_VAL_MARKER_EVENT2 Marker 2
NIRFSG_VAL_MARKER_EVENT3Marker 3
" " (empty string)None (no signal to export)

This parameter is useful when the signal parameter is set to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT. Otherwise, set the signalIdentifier parameter to "" (empty string).

outputTerminal ViConstString Specifies the terminal where the signal will be exported.

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. Examine the status code from each call to an instrument driver function to determine if an error occurred.

To obtain a text description of the status code, call the niRFSG_error_message function. To obtain additional information about the error condition, call the niRFSG_GetError function. To clear the error information from the driver, call the niRFSG_ClearError function.

The general meaning of the status code is as follows:

ValueMeaning
0Success
Positive ValuesWarnings
Negative ValuesErrors
previous page start next page