niVNA_GetAttributeViString
- Updated2023-02-21
- 1 minute(s) read
niVNA_GetAttributeViString
niVNA_GetAttributeViString(ViSession instrumentHandle, ViConstString channel, ViAttr attributeID, ViInt32 bufferSize, ViChar value[]);
Purpose
Queries the value of a ViString attribute.
You can use this low-level function to get the values of inherent IVI attributes, and instrument-specific attributes.
Supported Devices: NI 5630/5632
Parameters
Input | ||
Name | Type | Description |
instrumentHandle | ViSession | Identifies your instrument handle. |
channel | ViConstString | Specifies the channel for which this operation is targeted. |
attributeID | ViAttr | Pass the ID of an attribute. |
bufferSize | ViInt32 | Pass the number of bytes in the ViChar buffer you specify for the attribute value parameter. If you pass a negative number, the function copies the value to the buffer regardless of the number of bytes in the value. If you pass 0, you can pass VI_NULL for the attribute value buffer parameter. |
Output | ||
Name | Type | Description |
value | ViChar[] | Returns the current value of the attribute. Pass the address of a ViString variable. |
Return Value
Name | Type | Description | ||||||||
returnValue | 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 NI-VNA function to determine if an error has occurred. To obtain a text description of the status code and additional information about the error condition, call the niVNA_GetError function. To clear the error information from NI-VNA, call the niVNA_ClearError function. The general meaning of the status code is as follows:
|
||||||||