A Property object represents a property of an object.
If an application sets the property value attribute of a Property object, the property value replaces any previous value the attribute had.
This class is a helper class.
Property(const String & propertyName, const xmsBOOL propertyValue); Property(const String & propertyName, const xmsSBYTE *propertyValue, xmsINT length); Property(const String & propertyName, const xmsSBYTE propertyValue); Property(const String & propertyName, const xmsCHAR16 propertyValue); Property(const String & propertyName, const xmsDOUBLE propertyValue); Property(const String & propertyName, const xmsFLOAT propertyValue); Property(const String & propertyName, const xmsINT propertyValue); Property(const String & propertyName, const xmsLONG propertyValue); Property(const String & propertyName, const xmsSHORT propertyValue); Property(const String & propertyName, const String & propertyValue);
Create a Property object with a property name, a property value, and a property type.
Property(const String & propertyName); Property & create(const String & propertyName);
Create a Property object with no property value or property type.
Method | Description |
---|---|
~Property | Delete the Property object. |
getBoolean | Get the boolean property value from the Property object. |
getByte | Get the byte property value from the Property object. |
getByteArray | Get the byte array property value from the Property object. |
getChar | Get the 2-byte character property value from the Property object. |
getDouble | Get the double precision floating point property value from the Property object. |
getFloat | Get the floating point property value from the Property object. |
getHandle | Get the handle that a C application would use to access the Property object. |
getInt | Get the integer property value from the Property object. |
getLong | Get the long integer property value from the Property object. |
getShort | Get the short integer property value from the Property object. |
getString | Get the string property value from the Property object. |
getTypeId | Get the property type from the Property object. |
isNull | Determine whether the Property object is a null object. |
isTypeId | Check whether the Property object has the specified property type. |
name | Get the property name from the Property object. |
setBoolean | Set a boolean property value in the Property object and set the property type. |
setByte | Set a byte property value in the Property object and set the property type. |
setByteArray | Set a byte array property value in the Property object and set the property type. |
setChar | Set a 2-byte character property value in the Property object and set the property type. |
setDouble | Set a double precision floating point property value in the Property object and set the property type. |
setFloat | Set a floating point property value in the Property object and set the property type. |
setInt | Set an integer property value in the Property object and set the property type. |
setLong | Set a long integer property value in the Property object and set the property type. |
setShort | Set a short integer property value in the Property object and set the property type. |
setString | Set a string property value in the Property object and set the property type. |
xmsINT getByteArray(xmsSBYTE *propertyValue, const xmsINT length, xmsINT *actualLength) const;
Get the byte array property value from the Property object.
For more information about how to use this method, see C++ methods that return a byte array.
String getString() const;
Get the string property value from the Property object.
xmsPROPERTY_TYPE getTypeId() const;
Get the property type from the Property object.
xmsBOOL isTypeId(const xmsPROPERTY_TYPE propertyType) const;
Check whether the Property object has the specified property type.
xmsVOID setByteArray(const xmsBYTE *propertyValue, const xmsINT length);
Set a byte array property value in the Property object and set the property type.
xmsVOID setDouble(const xmsDOUBLE propertyValue);
Set a double precision floating point property value in the Property object and set the property type.