niRFSG_ConfigurePXIChassisClk10

NI-RFSG C Function

niRFSG_ConfigurePXIChassisClk10

C Function Prototype

ViStatus niRFSG_ConfigurePXIChassisClk10 (ViSession vi, ViConstString pxiClk10Source);

Purpose

Specifies the signal to drive the 10 MHz reference clock on the PXI backplane. This option can only be configured when the NI PXI-5610 is in Slot 2 of the PXI chassis. The NI-RFSG device must be in the Configuration state before you call this function.

Supported Devices: NI 5670/5671

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

pxiClk10Source ViConstString Specifies the signal to drive the 10 MHz reference clock to the PXI backplane. You can select None (default), RefIn, or OnboardClock as the value for this control. Only certain combinations of pxiClk10Source and NIRFSG_ATTR_REF_CLOCK_SOURCE are valid, as shown in the following table:

Valid PXI Chassis Clk10 SettingValid Ref Clock Setting
NIRFSG_VAL_NONE, NIRFSG_VAL_ONBOARD_CLK_STRNIRFSG_VAL_ONBOARD_CLK_STR
NIRFSG_VAL_NONE, NIRFSG_VAL_REF_IN_STR NIRFSG_VAL_REF_IN_STR
NIRFSG_VAL_NONE, NIRFSG_VAL_REF_IN_STRNIRFSG_VAL_PXI_CLK10_STR

NI-RFSG sets the NIRFSG_ATTR_PXI_CHASSIS_CLK10_SOURCE attribute to this value.

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