niRFSG_ConfigureDigitalLevelScriptTrigger

NI-RFSG C Function

niRFSG_ConfigureDigitalLevelScriptTrigger

C Function Prototype

ViStatus niRFSG_ConfigureDigitalLevelScriptTrigger (ViSession vi, ViConstString Trigger_Identifier, ViConstString Source, ViInt32 Level);

Purpose

Configures a specified Script trigger for digital level triggering.

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.
source ViConstString Specifies the trigger source terminal for the digital level script trigger. NI-RFSG sets NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE to this value.
Level ViInt32 Specifies the active level for the digital level script trigger. NI-RFSG sets NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_ACTIVE_LEVEL 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