niRFSG_SetWaveformMarkerEventLocations
- Updated2024-05-08
- 1 minute(s) read
niRFSG_SetWaveformMarkerEventLocations
C Function Prototype
ViStatus niRFSG_SetWaveformMarkerEventLocations (ViSession vi, ViConstString channelName, ViInt32 numberOfLocations, ViReal64* locations);
Purpose
Configures the marker locations associated with waveform and marker in the NI-RFSG session.
Supported Devices: PXIe-5820/5830/5831/5832/5840/5841/5842
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. |
| channelName | ViConstString | Specifies the waveform name and the marker name.
Example:
|
| numberOfLocations | NIComplexI16[] | Specifies the size of the locations array. |
| locations | ViReal64 | Specifies the marker location, in samples, to store in the NI-RFSG database. |
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 error code, call the niRFSG_GetError function. The general meaning of the status code is as follows:
|
||||||||