niRFSA_ConfigureSoftwareEdgeRefTrigger
ViStatus = niRFSA_ConfigureSoftwareEdgeRefTrigger( ViSession vi, ViInt64 pretriggerSamples);
Purpose
Configures the device to wait for a software Reference trigger to mark a reference point within the record. The device waits until you call the niRFSA_SendSoftwareEdgeTrigger function to assert the trigger.
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. |
| pretriggerSamples | ViInt64 | Specifies the number of samples to store for each record that were acquired in the time period immediately before the trigger occurred. |
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 |