System CATSysSettingRepository

Usage: you must use this class as is. You should never derive it.

public class CATSysSettingRepository

Class to manipulate settings controlled by XML metadata.
Role: CATSysSettingRepository provide the methods to manipulate settings attributes under the control of a XML description. Only attributes defined in the XML metadata file will be accessible. The informations in the XML give the default value of each attribute and a set of validating data, such as a range or a list of authorized values.

CATSysSettingRepository also offers you a couple of ReadAttr/WriteAttr methods that encapsulates the access to the setting repository for each setting attribute supported type:

• A pointer to, or a table of pointers to
• A pointer to, or a table of pointers to
• A table of pointers to simple types: char, double, float, int, short,and unsigned int

Constructor and Destructor Index

o ~CATSysSettingRepository()

Method Index

o CATDeclareCBEvent(CATSysSettingRepository_Updated)

Declares the SettingRepository_Updated event for a global update of the setting repository managed by the setting controller.

o Commit(int)

Makes a memory copy of the setting attribute values.

o DelAttr(char*)

Deletes an attribute from a setting repository
Role:

o GetInfo(char*,CATSettingInfo*,int)

Retrieves information associated with a given setting attribute.

o GetName()

o GetRepository(char*,int)

Creates a CATSysSettingRepository.

o Lock(char*)

Locks a given setting attribute.

o MapLevel(CATSettingInfo&,CATUnicodeString&)

Returns the Administration Level.

o MapLock(char)

Returns the locking state.

o MapLock(CATSettingInfo&,CATUnicodeString&)

Returns the locking state.

o NextAttribute(char*,char*,CATLONG32*,short)

Browses the setting.

o ReadAttr(char*,int**)

Retrieves the value of a setting attribute made up of an array of ints.

o ReadAttr(char*,char**)

Retrieves the value of a setting attribute made up of an array of chars.

o ReadAttr(char*,float**)

Retrieves the value of a setting attribute made up of an array of floats.

o ReadAttr(char*,short**)

Retrieves the value of a setting attribute made up of an array of shorts.

o ReadAttr(char*,double**)

Retrieves the value of a setting attribute made up of an array of doubles.

o ReadAttr(char*,CATString*)

Retrieves the value of a setting attribute made up of a pointer to CATString.

o ReadAttr(char*,int*,CATLONG32)

Retrieves the value of a setting attribute made up of an array of ints.

o ReadAttr(char*,char*,CATLONG32)

Retrieves the value of a setting attribute made up of an array of chars.

o ReadAttr(char*,unsigned int**)

Retrieves the value of a setting attribute made up of an array of unsigned ints.

o ReadAttr(char*,float*,CATLONG32)

Retrieves the value of a setting attribute made up of an array of floats.

o ReadAttr(char*,short*,CATLONG32)

Retrieves the value of a setting attribute made up of an array of shorts.

o ReadAttr(char*,double*,CATLONG32)

Retrieves the value of a setting attribute made up of an array of doubles.

o ReadAttr(char*,CATString**&)

Retrieves the value of a setting attribute made up of an array of pointers to CATString.

o ReadAttr(char*,CATUnicodeString*)

Retrieves the value of a setting attribute made up of a pointer to CATUnicodeString.

o ReadAttr(char*,CATString**,CATLONG32)

Retrieves the value of a setting attribute made up of an array of pointers to CATString.

o ReadAttr(char*,unsigned int*,CATLONG32)

Retrieves the value of a setting attribute made up of an array of unsigned ints.

o ReadAttr(char*,CATUnicodeString**&)

Retrieves the value of a setting attribute made up of an array of pointers to CATUnicodeString.

o ReadAttr(char*,CATUnicodeString**,CATLONG32)

Retrieves the value of a setting attribute made up of an array of pointers to CATUnicodeString.

o ResetToAdminValues(char**,int)

Restores the administrated values of the attributes.

o Rollback()

Restores the last memory copy of the setting attribute values.

o SaveRepository(char*)

Makes a persistent copy of the setting attribute values on file.

o Unlock(char*)

Unlocks a given setting attribute.

o WriteAttr(char*,CATString*)

Sets the value of a setting attribute made up of a pointer to CATString.

o WriteAttr(char*,int*,CATLONG32)

Sets the value of a setting attribute made up of an array of ints.

o WriteAttr(char*,char*,CATLONG32)

Sets the value of a setting attribute made up of an array of chars.

o WriteAttr(char*,float*,CATLONG32)

Sets the value of a setting attribute made up of an array of floats.

o WriteAttr(char*,short*,CATLONG32)

Sets the value of a setting attribute made up of an array of shorts.

o WriteAttr(char*,double*,CATLONG32)

Sets the value of a setting attribute made up of an array of doubles.

o WriteAttr(char*,CATUnicodeString*)

Sets the value of a setting attribute made up of a pointer to CATUnicodeString.

o WriteAttr(char*,CATString**,CATLONG32)

Sets the value of a setting attribute which is an array of CATString.

o WriteAttr(char*,unsigned int*,CATLONG32)

Sets the value of a setting attribute made up of an array of unsigned ints.

o WriteAttr(char*,CATUnicodeString**,CATLONG32)

Sets the value of a setting attribute made up of an array of pointers to CATUnicodeString.

Constructor and Destructor

Methods

Declares the SettingRepository_Updated event for a global update of the setting repository managed by the setting controller.
Role: A global update of the setting repository managed by the setting controller happens, and the SettingRepository_Updated event is sent, whenever one of the methods , , and are called.

Makes a memory copy of the setting attribute values.
Role: Commit saves the current values of the setting attributes managed by the setting controller in a specific memory area. Successive calls to Commit overwrite the memory area. The values saved by the last call to Commit can be restored from that memory area using the method.

Parameters:

iNoEvent

[in] Reserved for internal use. Do not use. Should always be set to 0

Returns:

Legal values: S_OK on success, and E_FAIL otherwise

Deletes an attribute from a setting repository
Role:

Parameters:

iAttributeName

An existing attribute name.

Returns:

Legal values 1 when the attribute was deleted and -1 when it wasn't found.

Retrieves information associated with a given setting attribute.
Role:Information that may be associated with a setting attribute consists in:

• Whether the setting attribute is locked
• Its default value

This information is retrieved as a pointer to a class instance. Depending on whether the setting attribute is locked, you can unlock or lock it using the retrieved pointer, like you can do it using the or methods of CATSysSettingRepository, providing the methods are called in the Administrator mode.

Parameters:

iAttributeName

[in] The name of the attribute.
Legal values: The length of this name must be less than or equal to

oInfo

[out] The retrieved information

iFlag

[in] Reserved for internal use. Do not use. Should always be set to 0

Returns:

Legal values: S_OK if the information is successfully retrieved, and E_FAIL otherwise

Creates a CATSysSettingRepository.
Role: Creates an instance of the class CATSysSettingRepository named with the given argument. If a setting file exists, it is read.

Parameters:

iName

The name of the CATSysSettingRepository used by the applications to retrieve it. Legal values: The length of the string must be less than or equal to

.

iMode

Reserved for internal use. Must always be set to 0. Legal values: The length of the string must be less than or equal to

.

Locks a given setting attribute.
Role: Locking a given attribute enables you to prevent any further modifications of its value. Locking setting attribute is dedicated to setting administrators, and is thus available in the Administrator mode only. Otherwise Lock simply returns S_OK without locking the setting attribute.

Parameters:

iAttributeName

[in] The name of the attribute to be locked.
Legal values: The length of this name must be less than or equal to

Returns:

Legal values: S_OK if the attribute was successfully locked, and E_FAIL otherwise

Returns the Administration Level.
Role: Returns the Administration Level of an attribute from the instance attached to it. This method is used in the macros that help you create your setting controller. You should not call it explicitely outside of these macros.

Parameters:

iInfo

a CATSettingInfo Structure retrieved by a call to GetInfo.

oLevel

a String that will be valuated.
Legal values:

Not administrated	The attribute is not administrated
Admin Level i	The Parameter is set at the level i of the CATReferenceSettingPath

Returns the locking state.
Role: Returns the locking state of an attribute from the instance attached to it. This method is used in the macros that help you create your setting controller. You should not call it explicitely outside of these macros.

Returns:

The locking state
Legal values:

Locked	The setting attribute is locked
Unlocked	The setting attribute is not locked
Upper Locked	The setting attribute is upper locked

Returns the locking state.
Role: Returns the locking state and level of an attribute from the instance attached to it. This method is used in the macros that help you create your setting controller. You should not call it explicitely outside of these macros.

Parameters:

iInfo

a CATSettingInfo Structure retrieved by a call to GetInfo.

oLockLevel

Legal values:

Locked	The setting attribute is locked
Unlocked	The setting attribute is not locked
Locked at Admin Level i	The setting attribute is lockedt the level i of the CATReferenceSettingPath

Browses the setting.
Role: Returns the Name, the type and the number of constituting elements of an attribute. The strings are copied but their allocation must be done by the caller.

Parameters:

oAttributeName

a pointer to an allocated buffer where the attribute's name will be copied

oAttributeClass

a pointer to an allocated buffer where the attribute's type will be copied

oAttributeSize

a pointer to a CATLONG32 int to put the number of constituting elements

iReset

iReset = 1 forces to begin with the first Attribute,reseting the state reached with the last call to this method, otherwise 0

Returns:

Legal values S_OK until reaching the last Attribute and returning E_FAIL when the last attribute is reached

Retrieves the value of a setting attribute made up of an array of ints.
Role: Retrieves, using its name, the values of each element of the array making up the attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[out] An array of ints.

Returns:

Legal values:
>0:on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of chars.
Role: Retrieves, using its name, the values of each element of the array making up the attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[out] An array of chars.

Returns:

Legal values:
>0:on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of floats.
Role: Retrieves, using its name, the values of each element of the array making up the attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[out] An array of floats.

Returns:

Legal values:
>0:on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of shorts.
Role: Retrieves, using its name, the values of each element of the array making up the attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[out] An array of shorts.

Returns:

Legal values:
>0: on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of doubles.
Role: Retrieves, using its name, the values of each element of the array making up the attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[out] An array of doubles.

Returns:

Legal values:
>0: on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of a pointer to CATString.
Role: Retrieves, using its name, the value of an attribute made up of a pointer to a CATString instance. A pointer to an intialized and constructed object of type CATString must be given as argument, because this object is used to set the default value of the attribute, if it does not yet exist. In this last case, the method calls WriteSetting to initialize the setting attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[inout] A pointer on a constructed CATString. If the attribute has not been yet created, then ioAttr is used as default values, otherwise ioAttrValue is overwritten by the retrieved value.

Returns:

Legal values:
1: on success
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of ints.
Role: Retrieves, using its name, the values of each element of the array making up the attribute. The array is defined as an array of initialized ints, because it is used to set the default value of the attribute, if it does not yet exist. In this last case the method calls WriteAttr to initialize the setting attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[inout] An array of initialized ints. If the attribute has not been yet created, then the elements of ioAttrValue are used as default values, otherwise the elements of ioAttrValue are overwritten by the retrieved values.

iSize

[in] The size of the array

Returns:

Legal values:
>0:on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of chars.
Role: Retrieves, using its name, the values of each element of the array making up the attribute. The array is defined as an array of initialized chars, because it is used to set the default value of the attribute, if it does not yet exist. In this last case the method calls WriteAttr to initialize the setting attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[inout] An array of initialized chars. If the attribute has not been yet created, then the elements of ioAttrValue are used as default values, otherwise the elements of ioAttrValue are overwritten by the retrieved values.

iSize

[in] The size of the array

Returns:

Legal values:
>0:on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of unsigned ints.
Role: Retrieves, using its name, the values of each element of the array making up the attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[out] An array of unsigned ints.

iSize

[in] The size of the array

Returns:

Legal values:
>0: on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of floats.
Role: Retrieves, using its name, the values of each element of the array making up the attribute. The array is defined as an array of initialized floats, because it is used to set the default value of the attribute, if it does not yet exist. In this last case the method calls WriteAttr to initialize the setting attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[inout] An array of initialized floats. If the attribute has not been yet created, then the elements of ioAttrValue are used as default values, otherwise the elements of ioAttrValue are overwritten by the retrieved values.

iSize

[in] The size of the array

Returns:

Legal values:
>0:on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of shorts.
Role: Retrieves, using its name, the values of each element of the array making up the attribute. The array is defined as an array of initialized shorts, because it is used to set the default value of the attribute, if it does not yet exist. In this last case the method calls WriteAttr to initialize the setting attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[inout] An array of initialized shorts. If the attribute has not been yet created, then the elements of ioAttrValue are used as default values, otherwise the elements of ioAttrValue are overwritten by the retrieved values.

iSize

[in] The size of the array

Returns:

Legal values:
>0: on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of doubles.
Role: Retrieves, using its name, the values of each element of the array making up the attribute. The array is defined as an array of initialized doubles, because it is used to set the default value of the attribute, if it does not yet exist. In this last case the method calls WriteAttr to initialize the setting attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[inout] An array of initialized doubles. If the attribute has not been yet created, then the elements of ioAttrValue are used as default values, otherwise the elements of ioAttrValue are overwritten by the retrieved values.

iSize

[in] The size of the array

Returns:

Legal values:
>0: on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of pointers to CATString.
Role: Retrieves, using its name, the values of each element of the array making up the attribute. The array is defined as an array of pointers on CATString. The array will be allocated by method. If it does not yet exist the defaults are taken from the xml metadata definitions.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

oAttrValue

[out] An array of pointers to CATString instances.

Returns:

Legal values:
>0:on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of a pointer to CATUnicodeString.
Role: Retrieves, using its name, the value of an attribute constituted by one CATUnicodeString. A pointer on a intialized and constructed object of type CATUnicodeString must be given as argument, because this object is used to set the default value of the attribute, if it does not yet exist. In this last case the method calls WriteAttr () to initialize the setting attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[inout] A pointer to an initialized and constructed CATUnicodeString instance. If the attribute has not been yet created, then ioAttrValue is used as default value, otherwise ioAttrValue is overwritten by the retrieved value.

Returns:

Legal values:
1: on success
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of pointers to CATString.
Role: Retrieves, using its name, the values of each element of the array making up the attribute. The array is defined as an array of pointers to constructed CATString, because it is used to set the default value of the attribute, if it does not yet exist. In this last case the method calls WriteAttr to initialize the setting attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[inout] An array of pointers to initialized and constructed CATString instances. If the attribute has not been yet created, then the elements of ioAttrValue are used as default values, otherwise the elements of ioAttrValue are overwritten by the retrieved values.

iSize

[in] The size of the array

Returns:

Legal values:
>0:on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of unsigned ints.
Role: Retrieves, using its name, the values of each element of the array making up the attribute. The array is defined as an array of initialized unsigned ints, because it is used to set the default value of the attribute, if it does not yet exist. In this last case the method calls WriteAttr to initialize the setting attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[inout] An array of initialized unsigned ints. If the attribute has not been yet created, then the elements of ioAttrValue are used as default values, otherwise the elements of ioAttrValue are overwritten by the retrieved values.

iSize

[in] The size of the array

Returns:

Legal values:
>0: on success, returns the number of elements really read
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Retrieves the value of a setting attribute made up of an array of pointers to CATUnicodeString.
Role: Retrieves, using its name, the values of each element of the array making up the attribute. The array is defined as an array of pointers on CATUnicodeString. The array will be allocated by method. If it does not yet exist the * defaults are taken from the xml metadata definitions.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

oAttrValue

[out] An array of pointers to CATUnicodeString instances

Returns:

Legal values:
>0:on success, returns the number of elements really read
-1: on failure
-2: on checking error.

Retrieves the value of a setting attribute made up of an array of pointers to CATUnicodeString.
Role: Retrieves, using its name, the values of each element of the array making up the attribute. The array is defined as an array of pointers to constructed CATUnicodeString, because it is used to set the default value of the attribute, if it does not yet exist. In this last case the method calls WriteAttr to initialize the setting attribute.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be retrieved or created.
Legal values: The name length must be less than or equal to

ioAttrValue

[inout] An array of pointers to initialized and constructed CATUnicodeString instances If the attribute has not been yet created, then the elements of ioAttrValue are used as default values, otherwise the elements of ioAttrValue are overwritten by the retrieved values.

iSize

[in] The size of the array

Returns:

Legal values:
>0:on success, returns the number of elements really read
-1: on failure
-2: on checking error.

Restores the administrated values of the attributes.
Role: ResetToAdminValues restores all the values of the setting attributes managed by the setting controller to either the values set by the setting administrator, or to their default values if the setting administrator did not change them.

Parameters:

iAttList

[in] Reserved for internal use. Do not use. Should always be set to NULL

iNbAtt

[in] Reserved for internal use. Do not use. Should always be set to 0

Returns:

Legal values: S_OK on success, and E_FAIL otherwise

Restores the last memory copy of the setting attribute values.
Role: Rollback restores the values of the setting attributes managed by the setting controller from the memory area. All values of the setting attributes managed by the setting controller modified since the last call to are restored to the values they had when this last was called.

Returns:

Legal values: S_OK on success, and E_FAIL otherwise

Makes a persistent copy of the setting attribute values on file.
Role: SaveRepository saves the current values of the setting attributes managed by the setting controller in a setting repository file. To avoid inconsistencies, SaveRepository first saves the values in the memory area used by the method by calling before writing the values in the setting repository file.

Parameters:

iTmp

[in] Reserved for internal use. Do not use. Should always be set to NULL

Returns:

Legal values: S_OK on success, and E_FAIL otherwise

Unlocks a given setting attribute.
Role: Unlocking a given attribute enables you to authorize further modifications of its value. Unlocking setting attribute is dedicated to setting administrators, and is thus available in the Administrator mode only. Otherwise Unlock simply returns S_OK without unlocking the setting attribute.

Parameters:

iAttributeName

[in] The name of the attribute to be unlocked.
Legal values: The length of this name must be less than or equal to

Returns:

Legal values S_OK if the attribute was successfully unlocked, and E_FAIL otherwise

Sets the value of a setting attribute made up of a pointer to CATString.
Role: Sets the value of an attribute made up of a pointer to a CATString instance.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be set.
Legal values: The name length must be less than or equal to

iAttrValue

[in] A pointer to an initialized CATString instance

Returns:

Legal values:
1: on success
-1: on failure
-2: on checking error.

Sets the value of a setting attribute made up of an array of ints.
Role: Sets the values of each element of the array constituting the attribute. The array is defined as an array of initialized ints.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be set.
Legal values: The name length must be less than or equal to

iAttrValue

[in] An array of initialized ints

iSize

[in] The size of the array

Returns:

Legal values:
1: on success
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Sets the value of a setting attribute made up of an array of chars.
Role: Sets the values of each element of the array making up the attribute. The array is defined as an array of initialized chars.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be set.
Legal values: The name length must be less than or equal to

iAttrValue

[in] An array of initialized chars

iSize

[in] The size of the array

Returns:

Legal values:
1: on success
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Sets the value of a setting attribute made up of an array of floats.
Role: Sets the values of each element of the array constituting the attribute. The array is defined as an array of initialized floats.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be set.
Legal values: The name length must be less than or equal to

iAttrValue

[in] An array of initialized floats

iSize

[in] The size of the array

Returns:

Legal values:
1: on success
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Sets the value of a setting attribute made up of an array of shorts.
Role: Sets the values of each element of the array constituting the attribute. The array is defined as an array of initialized shorts.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be set.
Legal values: The name length must be less than or equal to

iAttrValue

[in] An array of initialized shorts

iSize

[in] The size of the array

Returns:

Legal values:
1: on success
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Sets the value of a setting attribute made up of an array of doubles.
Role: Sets the values of each element of the array constituting the attribute. The array is defined as an array of initialized doubles.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be set.
Legal values: The name length must be less than or equal to

iAttrValue

[in] An array of initialized doubles

iSize

[in] The size of the array

Returns:

Legal values:
1: on success
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Sets the value of a setting attribute made up of a pointer to CATUnicodeString.
Role: Sets the value of an attribute made up of a pointer to a CATUnicodeString instance.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be set.
Legal values: The name length must be less than or equal to

iAttrValue

[in] A pointer to an initialized and constructed CATUnicodeString instance.

Returns:

Legal values:
1: on success
-1: on failure
-2: on checking error.

Sets the value of a setting attribute which is an array of CATString.
Role: Sets the values of each element of the array making up the attribute. Each of these elements is a pointer to a constructed CATString instance.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be set.
Legal values: The name length must be less than or equal to

iAttrValue

[in] An array of pointers to initialized and constructed CATString instances

iSize

[in] The size of the array

Returns:

Legal values:
1: on success
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Sets the value of a setting attribute made up of an array of unsigned ints.
Role: Sets the values of each element of the array constituting the attribute. The array is defined as an array of initialized unsigned ints.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be set.
Legal values: The name length must be less than or equal to

iAttrValue

[in] An array of initialized unsigned ints

iSize

[in] The size of the array

Returns:

Legal values:
1: on success
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Sets the value of a setting attribute made up of an array of pointers to CATUnicodeString.
Role: Sets the values of each element of the array making up the attribute. Each of these elements is a pointer to a constructed CATUnicodeString instance.

Parameters:

iAttrName

[in] The name of the attribute whose value is to be set.
Legal values: The name length must be less than or equal to

iAttrValue

[in] An array of pointers to initialized and constructed CATUnicodeString instances

iSize

[in] The size of the array

Returns:

Legal values:
1: on success
-1: on failure
-2: on checking error.
-3: undeclared attribute.

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.