Ivi_AttributeEverSetByUser
Usage
ViBoolean Ivi_AttributeEverSetByUser (ViSession vi, ViChar repeatedCapability[], ViAttr attributeID);
Purpose
This function indicates whether the IVI engine believes that the attribute was ever set to a user specified value since the last time that the session was initialized or reset.
An attribute is marked as set by a user specified value when the Ivi_SetAttribute function is called with the IVI_VAL_DIRECT_USER_CALL flag and without the IVI_VAL_DONT_MARK_AS_SET_BY_USER flag.
Parameters
| Input | ||
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The ViSession handle that you obtain from Ivi_SpecificDriverNew. The handle identifies a particular IVI session. |
| repeatedCapability | ViChar[] | If the attribute you specify is based on a repeated capability, pass a repeated capability identifier. You can pass one of the identifiers strings that the specific instrument driver defines, or a virtual name the end-user defines in the configuration file. If the attribute you specify is not based on a repeated capability, pass VI_NULL or an empty string. |
| attributeID | ViAttr | Pass the ID of an attribute for this parameter. The include file for a specific instrument driver defines constant names for all of the user-accessible attributes that apply to the driver. This includes attributes that the IVI engine defines, attributes that the instrument class defines, and attributes that are specific to the particular instrument. Each defined constant name begins with PREFIX_ATTR_, where PREFIX is the specific instrument prefix. For each IVI engine attribute, the specific driver include file uses the same constant name that appears in ivi.h, except that the specific instrument prefix replaces the IVI prefix. For example, ivi.h defines IVI_ATTR_CACHE, and the Fluke 45 include file, fl45.h, defines the following constant name: #define FL45_ATTR_CACHE IVI_ATTR_CACHE For each instrument class attribute, the specific driver include file uses the same constant name that appears in the instrument class include file, except that the specific instrument prefix replaces the class prefix. For example, the DMM class include file, ividmm.h, defines IVIDMM_ATTR_RANGE, and fl45.h defines the following constant name: #define FL45_ATTR_RANGE IVIDMM_ATTR_RANGE For each specific instrument attribute, the specific driver include file defines a constant name and assigns a value that is an offset from IVI_SPECIFIC_PUBLIC_ATTR_BASE. For example, fl45.h defines the following constant name: |
Return Value
Returns the value of the Ivi_AttributeEverSetByUser variable for the session and attribute.