Methods
- Func GetAttr( iAttrName) As
-
Retieves a attribute.
- Parameters:
-
- iAttrName
- the attribute name
- oAttr
- a CATVariant
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
- Func GetAttrArray( iAttrName) As
-
Retieves a attribute of type array
- Parameters:
-
- iAttrName
- the attribute name
- oArray
- a CATSafeArrayVariant
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
- Sub GetAttrInfo( iAttrName, AdminLevel, Locked, oModified)
-
Retrieves environment informations for the given attribute.
Role: This information defines the state of the setting parameter and is made up of:- The administration level that sets the current value or the value used to reset it
- The administration level that has locked the setting parameter.
- A flag to indicate whether the setting parameter was modified.
- Parameters:
-
- iAttrName
- [in] the attribute name.
- ioAdminLevel
- [inout] The administration level that defines the value used when resetting the
setting parameter.
Legal values:
- Default value if the setting parameter has never been explicitly set in the administration concatenation.
- Set at Admin Level n if the setting parameter has been
administered,
where n is an integer starting from 0 representing the rank of the administration level.
- ioLocked
- [inout] A character string to indicate whether the parameter is locked and the
level of administration where the locking has been proceeded.
Legal values:- Locked at Admin Level n if the setting parameter is locked by
then administration level n,
where n is an integer starting from 0. The setting parameter can not be modified at the current level. - Locked if the setting parameter is locked by the current administration level. Only an admistrator can get this value.
- Unlocked if the setting parameter is not locked
- Locked at Admin Level n if the setting parameter is locked by
then administration level n,
- oModified
- [out] True to indicate that the setting parameter value has been explicitely modified at the current administrator or user level. This is only possible with unlocked parameters. False means that it inherits the administered value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
- Sub PutAttr( iAttrName, iAttr)
-
Sets an attribute of type array.
- Parameters:
-
- iAttrName
- the attribute name
- iArray
- a CATSafeArrayVariant.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
- Sub PutAttrArray( iAttrName, iArray)
-
Sets an attribute of type array.
- Parameters:
-
- iAttrName
- the attribute name
- iArray
- a CATSafeArrayVariant.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
- Sub SetAttrLock( iAttrName, iLocked)
-
Locks or unlocks an attribute.
Role: Locking a setting attribute prevents the end user, or the administrators below the current one, from changing the setting parameter value. Locking or unlocking the attribute setting parameter is an administrator task and is possible when running a session in the administration mode only.- Parameters:
-
- iAttrName
- [in] the attribute name.
- iLocked
- [in] A flag to indicate whether the attribute setting parameter should be
locked.
Legal values: True to lock, and False to unlock.