niRFSG_CheckAttributeViString
C Function Prototype
ViStatus niRFSG_CheckAttributeViString (ViSession vi, ViConstString channelName, ViAttr attributeID, ViConstString attributeValue);
Purpose
Checks the validity of a value you specify for a ViString attribute.
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. Default Value: None |
||
| channelName | ViConstString | Specifies the channel to which the attribute applies if this attribute is channel-based. If the attribute is not channel-based, set this parameter to "" (empty string) or VI_NULL. Default Value: "" (empty string) |
||
| attributeID | ViAttr | Pass the ID of an attribute. | ||
| attributeValue | ViConstString | Pass the value that you want to verify as a valid value for the attribute. The value must be a NULL-terminated string.
Default Value: None |
||
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 status code, call the niRFSG_error_message function. To obtain additional information about the error condition, call the niRFSG_GetError function. To clear the error information from the driver, call the niRFSG_ClearError function. The general meaning of the status code is as follows:
|