niFgen_CheckAttributeViSession
ViStatus niFgen_CheckAttributeViSession (ViSession vi, ViConstString channelName, ViAttr attributeID, ViSession attributeValue);
Purpose
Checks the validity of a value you specify for a ViSession attribute.
Parameters
| Input | ||||
| Name | Type | Description | ||
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session. | ||
| channelName | ViConstString | Specifies the name of the channel on which to check the attribute value if the attribute is channel-based. If the attribute is not channel-based, then pass VI_NULL or an empty string ("").
Default Value: "" (empty string) |
||
| attributeID | ViAttr | Specifies the ID of an attribute. | ||
| attributeValue | ViInt32 | Specifies the value to which you want to set the attribute.
|
||
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. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred.
To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows:
|