niRFSG_SendSoftwareEdgeTrigger

NI-RFSG C Function

niRFSG_SendSoftwareEdgeTrigger

C Function Prototype

ViStatus niRFSG_SendSoftwareEdgeTrigger (ViSession vi, ViInt32 trigger, ViConstString triggerIdentifier);

Purpose

Forces a particular trigger to occur. The specified trigger is generated regardless of whether the trigger has been configured as a Software trigger.

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

trigger ViInt32 Specifies the trigger to assert.
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