niRFSA_SendSoftwareEdgeTrigger
ViStatus = niRFSA_SendSoftwareEdgeTrigger( ViSession vi, ViInt32 trigger, ViConstString triggerIdentifier);
Purpose
Sends a trigger to the device when you configure a software version of a supported trigger and the device is waiting for the trigger to be sent. This function also can be used to override a hardware trigger.
This function returns an error in the following situations:
- You configure an invalid trigger
- You are in spectrum mode
- You have not previously called the niRFSA_Initiate function.
NI-Scope handles other errors.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niRFSA_init or the niRFSA_initWithOptions functions and identifies a particular instrument session. |
| trigger | ViInt32 | Specifies the software signal to send. You can send a Start, Reference, Advance, or Arm Reference trigger. |
| triggerIdentifier | ViConstString | Specifies a particular instance of a trigger. This parameter currently is not supported. |
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. You 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 niRFSA_error_message function. To obtain additional information about the error condition, call the niRFSA_GetError function. To clear the error information from the driver, call the niRFSA_ClearError function. The general meaning of the status code is as follows:
|
Meaning | |
|---|---|---|---|---|
| 0 | Success | |||
| Positive Values | Warnings | |||
| Negative Values | Errors |