AMETEK Ls Series Driver Manual - Manual (Page 257)

IVI Driver Manual Lx / Ls Series
253
ciLxs_SetAttributeViString
ViStatus ciLxs_SetAttributeViString (ViSession instrumentHandle,
ViChar _VI_FAR channelName[],
ViAttr attributeID,
ViChar _VI_FAR attributeValue[]);
Purpose
This function sets the value of a ViString attribute.
This is a low-level function that you can use to set 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 or
is different than the value you specify.
This instrument driver contains high-level functions that set most of the
instrument attributes. It is best to use the high-level driver functions
as much as possible. They handle order dependencies and multithread
locking for you. In addition, they perform status checking only after
setting all of the attributes. In contrast, when you set multiple
attributes using the SetAttribute functions, the functions check the
instrument status after each call.
Also, when state caching is enabled, the high-level functions that
configure multiple attributes perform instrument I/O only for the
attributes whose value you change. Thus, you can safely call the
high-level functions without the penalty of redundant instrument I/O.
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 set. If the attribute is not