Returns the marker locations associated with the waveform and the marker stored in the NI-RFSG session.

Syntax

ViStatus __stdcall niRFSG_GetWaveformMarkerEventLocations(ViSession vi, ViConstString channelName, ViInt32 numberOfLocations, ViReal64 locations[], ViInt32 *requiredSize)

Remarks

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841/5842

Parameters

NameDirectionTypeDescription
vi[in]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[in]ViConstString

Specifies the waveform name and the marker name.

Example:

"waveform::waveform0/marker0"

numberOfLocations[in]ViInt32

Specifies the size of the locations array.

locations[out]ViReal64[]

Returns the marker locations stored in the NI-RFSG database for the channel you specified in the channelName parameter. This value is expressed in samples.

requiredSize[out]ViInt32 *

Returns the required size for the output array if you pass NULL to Locations parameter.

Returns

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:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors