niRFSG_DisableScriptTrigger

NI-RFSG C Function

niRFSG_DisableScriptTrigger

Specific Function

C Function Prototype

ViStatus niRFSG_DisableScriptTrigger (ViSession vi, ViConstString triggerIdentifier);

Purpose

Configures the device to not wait for the specified Script trigger after the niRFSG_Initiate function is called. Calling the niRFSG_DisableScriptTrigger function is only necessary if the Script trigger has been previously configured and now must be disabled. The NI-RFSG device must be in the Configuration state before you call this function.

Supported Devices: NI 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

triggerIdentifier ViConstString Specifies which of the four available Script triggers is configured.

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