niRFSG_GetAllNamedWaveformNames
- Updated2025-10-14
- 1 minute(s) read
Return names of the waveforms present in the memory.
Syntax
ViStatus __stdcall niRFSG_GetAllNamedWaveformNames(ViSession vi, ViChar waveformNames[], ViInt32 bufferSize, ViInt32 *actualBufferSize)
Remarks
Supported Devices: PXIe-5830/5831/5840/5841/5842E
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| 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. |
| waveformNames | [out] | ViChar[] | Returns a string having waveform names separated by commas. |
| bufferSize | [in] | ViInt32 | Pass the number of bytes in the ViChar buffer you specify for the waveformNames parameter. If you pass 0, you can pass VI_NULL for the waveformNames parameter. |
| actualBufferSize | [out] | ViInt32 * | Fetch the number of bytes needed to pass in the bufferSize parameter. It can be fetch by passing VI_NULL in the waveformNames 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 |