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.
Function | Description |
---|---|
xmsPropertyCreate | Create a Property object with no property value or property type. |
xmsPropertyDispose | Delete the Property object. |
xmsPropertyDuplicate | Copy the Property object. |
xmsPropertyGetBoolean | Get the boolean property value from the Property object. |
xmsPropertyGetByte | Get the byte property value from the Property object. |
xmsPropertyGetByteArray | Get the byte array property value from the Property object. |
xmsPropertyGetByteArrayByRef | Get a pointer to the byte array property value in the Property object. |
xmsPropertyGetChar | Get the 2-byte character property value from the Property object. |
xmsPropertyGetDouble | Get the double precision floating point property value from the Property object. |
xmsPropertyGetFloat | Get the floating point property value from the Property object. |
xmsPropertyGetInt | Get the integer property value from the Property object. |
xmsPropertyGetLong | Get the long integer property value from the Property object. |
xmsPropertyGetName | Get the property name from the Property object. |
xmsPropertyGetShort | Get the short integer property value from the Property object. |
xmsPropertyGetString | Get the string property value from the Property object. |
xmsPropertyGetStringByRef | Get a pointer to the string property value in the Property object. |
xmsPropertyGetTypeId | Get the property type from the Property object. |
xmsPropertyIsTypeId | Check whether the Property object has the specified property type. |
xmsPropertySetBoolean | Set a boolean property value in the Property object and set the property type. |
xmsPropertySetByte | Set a byte property value in the Property object and set the property type. |
xmsPropertySetByteArray | Set a byte array property value in the Property object and set the property type. |
xmsPropertySetChar | Set a 2-byte character property value in the Property object and set the property type. |
xmsPropertySetDouble | Set a double precision floating point property value in the Property object and set the property type. |
xmsPropertySetFloat | Set a floating point property value in the Property object and set the property type. |
xmsPropertySetInt | Set an integer property value in the Property object and set the property type. |
xmsPropertySetLong | Set a long integer property value in the Property object and set the property type. |
setShortxmsPropertySetShort | Set a short integer property value in the Property object and set the property type. |
xmsPropertySetString | Set a string property value in the Property object and set the property type. |
xmsRC xmsPropertyCreate(xmsCHAR *propertyName, xmsHProperty *property, xmsHErrorBlock errorBlock);
Create a Property object with no property value or property type.
xmsRC xmsPropertyDispose(xmsHProperty *property, xmsHErrorBlock errorBlock);
If an application tries to delete a Property object that is already deleted, the call is ignored.
xmsRC xmsPropertyDuplicate(xmsHProperty property, xmsHProperty *copiedProperty, xmsHErrorBlock errorBlock);
xmsRC xmsPropertyGetBoolean(xmsHProperty property, xmsBOOL *propertyValue, xmsHErrorBlock errorBlock);
Get the boolean property value from the Property object.
xmsRC xmsPropertyGetByte(xmsHProperty property, xmsSBYTE *propertyValue, xmsHErrorBlock errorBlock);
Get the byte property value from the Property object.
xmsRC xmsPropertyGetByteArray(xmsHProperty property, xmsSBYTE *propertyValue, xmsINT length, xmsINT *actualLength, xmsHErrorBlock errorBlock);
Get the byte array property value from the Property object.
For more information about how to use this function, see C functions that return a byte array by value.
xmsRC xmsPropertyGetByteArrayByRef(xmsHProperty property, xmsSBYTE **propertyValue, xmsINT *length, xmsHErrorBlock errorBlock);
Get a pointer to the byte array property value in the Property object.
For more information about how to use this function, see C functions that return a string or byte array by reference.
xmsRC xmsPropertyGetChar(xmsHProperty property, xmsCHAR16 *propertyValue, xmsHErrorBlock errorBlock);
Get the 2-byte character property value from the Property object.
xmsRC xmsPropertyGetDouble(xmsHProperty property, xmsDOUBLE *propertyValue, xmsHErrorBlock errorBlock);
Get the double precision floating point property value from the Property object.
xmsRC xmsPropertyGetFloat(xmsHProperty property, xmsFLOAT *propertyValue, xmsHErrorBlock errorBlock);
Get the floating point property value from the Property object.
xmsRC xmsPropertyGetInt(xmsHProperty property, xmsINT *propertyValue, xmsHErrorBlock errorBlock);
Get the integer property value from the Property object.
xmsRC xmsPropertyGetLong(xmsHProperty property, xmsLONG *propertyValue, xmsHErrorBlock errorBlock);
Get the long integer property value from the Property object.
xmsRC xmsPropertyGetName(xmsHProperty property, xmsCHAR *propertyName, xmsINT length, xmsINT *actualLength, xmsHErrorBlock errorBlock);
Get the property name from the Property object.
For more information about how to use this function, see C functions that return a string by value.
xmsRC xmsPropertyGetShort(xmsHProperty property, xmsSHORT *propertyValue, xmsHErrorBlock errorBlock);
Get the short integer property value from the Property object.
xmsRC xmsPropertyGetString(xmsHProperty property, xmsCHAR *propertyValue, xmsINT length, xmsINT *actualLength, xmsHErrorBlock errorBlock);
Get the string property value from the Property object.
For more information about how to use this function, see C functions that return a string by value.
xmsRC xmsPropertyGetStringByRef(xmsHProperty property, xmsCHAR **propertyValue, xmsINT *length, xmsHErrorBlock errorBlock);
Get a pointer to the string property value in the Property object.
For more information about how to use this function, see C functions that return a string or byte array by reference.
Note that the property value must be a string. The function makes no attempt to convert a property value with another data type into a string. If an application calls this function to get a pointer to a property value that is not a string, XMS returns an error.
xmsRC xmsPropertyGetTypeId(xmsHProperty property, xmsPROPERTY_TYPE *propertyType, xmsHErrorBlock errorBlock);
Get the property type from the Property object.
xmsRC xmsPropertyIsTypeId(xmsHProperty property, xmsPROPERTY_TYPE propertyType, xmsBOOL *isType, xmsHErrorBlock errorBlock);
Check whether the Property object has the specified property type.
xmsRC xmsPropertySetBoolean(xmsHProperty property, xmsBOOL propertyValue, xmsHErrorBlock errorBlock);
Set a boolean property value in the Property object and set the property type.
xmsRC xmsPropertySetByte(xmsHProperty property, xmsSBYTE propertyValue, xmsHErrorBlock errorBlock);
Set a byte property value in the Property object and set the property type.
xmsRC xmsPropertySetByteArray(xmsHProperty property, xmsSBYTE *propertyValue, xmsINT length, xmsHErrorBlock errorBlock);
Set a byte array property value in the Property object and set the property type.
xmsRC xmsPropertySetChar(xmsHProperty Property, xmsCHAR16 propertyValue, xmsHErrorBlock errorBlock);
Set a 2-byte character property value in the Property object and set the property type.
xmsRC xmsPropertySetDouble(xmsHProperty property, xmsDOUBLE propertyValue, xmsHErrorBlock errorBlock);
Set a double precision floating point property value in the Property object and set the property type.
xmsRC xmsPropertySetFloat(xmsHProperty property, xmsFLOAT propertyValue, xmsHErrorBlock errorBlock);
Set a floating point property value in the Property object and set the property type.
xmsRC xmsPropertySetInt(xmsHProperty property, xmsINT propertyValue, xmsHErrorBlock errorBlock);
Set an integer property value in the Property object and set the property type.
xmsRC xmsPropertySetLong(xmsHProperty property, xmsLONG propertyValue, xmsHErrorBlock errorBlock);
Set a long integer property value in the Property object and set the property type.
xmsRC xmsPropertySetShort(xmsHProperty property, xmsSHORT propertyValue, xmsHErrorBlock errorBlock);
Set a short integer property value in the Property object and set the property type.
xmsRC xmsPropertySetString(xmsHProperty property, xmsCHAR *propertyValue, xmsINT length, xmsHErrorBlock errorBlock);
Set a string property value in the Property object and set the property type.