ViStatus pi40iv_GetAttributeViBoolean (ViSession instrumentHandle, ViChar _VI_FAR channelName[], ViAttr attributeID, ViPBoolean attributeValue);
This function queries the value of a ViBoolean attribute.
You can use this function to get the values of instrument- specific attributes and inherent IVI 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.
Input | ||
Name | Type | Description |
instrumentHandle | ViSession |
The ViSession handle that you obtain from the pi40iv_init or pi40iv_InitWithOptions function. The handle identifies a particular instrument session.
|
channelName | ViChar[] |
If the attribute is channel-based, this parameter specifies the name of the channel on which to obtain the value of the attribute. If the attribute is not channel-based, then pass VI_NULL or an empty string.
|
attributeID | ViAttr |
Pass the ID of an attribute.
|
Output | ||
Name | Type | Description |
attributeValue | ViBoolean (passed by reference) |
Returns the current value of the attribute. Pass the address of a ViBoolean variable.
|
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 examine the status code from each call to an instrument driver function to determine if an error occurred.
|
Get Attribute
Set/Get/Check Attribute
Configuration
Pickering Interfaces PXI/LXI IVI Switch
Alphabetical Function Index
Hierarchical Function Index