niRFSG_CheckAttributeViString
- Updated2025-10-14
- 1 minute(s) read
Checks the validity of a value you specify for a ViString attribute.
Syntax
ViStatus __stdcall niRFSG_CheckAttributeViString(ViSession vi, ViConstString channelName, ViAttr attribute, ViConstString value)
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" |
| attribute | [in] | ViAttr | Pass the ID of an attribute. |
| value | [in] | ViConstString | Pass the value that you want to verify as a valid value for the attribute. The value must be a NULL-terminated string. Note Some of the values might not be valid depending on the current settings of the instrument session. |
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 |