beautypg.com

Cilxs_getattributeviint32 – AMETEK Ls Series Driver Manual User Manual

Page 159

background image

IVI Driver Manual

Lx / Ls Series

155

ciLxs_GetAttributeViInt32


ViStatus ciLxs_GetAttributeViInt32 (ViSession instrumentHandle,
ViChar _VI_FAR channelName[],
ViAttr attributeID,
ViPInt32 attributeValue);

Purpose

This function queries the value of a ViInt32 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.



Parameter List

instrumentHandle

Variable Type ViSession

The ViSession handle that you obtain from the ciLxs_init or
ciLxs_InitWithOptions function. The handle identifies a particular
instrument session.

Default Value: None


channelName

Variable Type ViChar[]

If the attribute is channel-based, this control specifies the name of

the channel whose attribute is to be retrieved. If the attribute is
not channel-based, then you set this control to empty string or
VI_NULL.

Pass the virtual channel name that you assign to the instrument in
the Configuration Utility.

Virtual channel names are aliases for instrument-specific channel
strings. The instrument-specific channel strings can differ from one
instrument to another. Virtual channel names allow you to use and
swap instruments without having to change the channel names in your
source code. You assign a virtual channel name to an
instrument-specific channel through the Configuration Utility. This
control accepts virtual channel names you have assigned to the
specific instrument you are using. It also accepts the

This manual is related to the following products: