niRFSG_GetAttributeViInt64
C Function Prototype
ViStatus niRFSG_GetAttributeViInt64 (ViSession vi, ViConstString Channel_Name, ViAttr Attribute_ID, ViInt64* Attribute_Value);
Purpose
Queries the value of a ViInt64 attribute.
You can use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:
- State caching is disabled for the entire session or for the particular attribute.
- State caching is enabled, and the currently cached value is invalid.
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. |
| Output | ||
| Name | Type | Description |
| Attribute_Value | ViInt64* | Returns the current value of the attribute. Pass the address of a ViInt64 variable. |
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:
|