niRFSG_ResetAttribute
- Updated2025-10-14
- 1 minute(s) read
Resets the attribute to its default value.
Syntax
ViStatus __stdcall niRFSG_ResetAttribute(ViSession vi, ViConstString channelName, ViAttr attributeId)
Remarks
Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860
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. |
| channelName | [in] | ViConstString | Specifies the waveform name and the marker name. Example: "waveform::waveform0/marker0" |
| attributeId | [in] | ViAttr | Pass the ID of an attribute. |
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 |