The PropertyContext class contains functions that get and set properties. These functions can operate on any object that can have properties.
All objects can have properties except ErrorBlock, Iterator, and Property objects.
Function | Description |
---|---|
xmsGetBooleanProperty | Get the value of the boolean property identified by name. |
xmsGetByteArrayProperty | Get the value of the byte array property identified by name. |
xmsGetByteArrayPropertyByRef | Get a pointer to the value of the byte array property identified by name. |
xmsGetByteProperty | Get the value of the byte property identified by name. |
xmsGetCharProperty | Get the value of the 2-byte character property identified by name. |
xmsGetDoubleProperty | Get the value of the double precision floating point property identified by name. |
xmsGetFloatProperty | Get the value of the floating point property identified by name. |
xmsGetHandleTypeId | Get the type of the handle for the object. |
xmsGetIntProperty | Get the value of the integer property identified by name. |
xmsGetLongProperty | Get the value of the long integer property identified by name. |
xmsGetObjectProperty | Get the value and data type of the property identified by name. |
xmsGetProperty | Get a Property object for the property identified by name. |
xmsGetShortProperty | Get the value of the short integer property identified by name. |
xmsGetStringProperty | Get the value of the string property identified by name. |
xmsGetStringPropertyByRef | Get a pointer to the value of the string property identified by name. |
xmsSetBooleanProperty | Set the value of the boolean property identified by name. |
xmsSetByteProperty | Set the value of the byte property identified by name. |
xmsSetByteArrayProperty | Set the value of the byte array property identified by name. |
xmsSetCharProperty | Set the value of the 2-byte character property identified by name. |
xmsSetDoubleProperty | Set the value of the double precision floating point property identified by name. |
xmsSetFloatProperty | Set the value of the floating point property identified by name. |
xmsSetIntProperty | Set the value of the integer property identified by name. |
xmsSetLongProperty | Set the value of the long integer property identified by name. |
xmsSetObjectProperty | Set the value and data type of a property identified by name. |
xmsSetProperty | Set the value of a property using a Property object. |
xmsSetShortProperty | Set the value of the short integer property identified by name. |
xmsSetStringProperty | Set the value of the string property identified by name. |
xmsRC xmsGetBooleanProperty(xmsHObj object, xmsCHAR *propertyName, xmsBOOL *propertyValue, xmsHErrorBlock errorBlock);
Get the value of the boolean property identified by name.
xmsRC xmsGetByteArrayProperty(xmsHObj object xmsCHAR *propertyName, xmsSBYTE *propertyValue, xmsINT length, xmsINT *actualLength xmsHErrorBlock errorBlock) const;
Get the value of the byte array property identified by name.
For more information about how to use this function, see C functions that return a byte array by value.
xmsRC xmsGetByteArrayPropertyByRef(xmsHObj object xmsCHAR *propertyName, xmsSBYTE **propertyValue, xmsINT *length, xmsHErrorBlock errorBlock) const;
Get a pointer to the value of the byte array property identified by name.
For more information about how to use this function, see C functions that return a string or byte array by reference.
xmsRC xmsGetByteProperty(xmsHObj object, xmsCHAR *propertyName, xmsSBYTE *propertyValue, xmsHErrorBlock errorBlock);
Get the value of the byte property identified by name.
xmsRC xmsGetCharProperty(xmsHObj object, xmsCHAR *propertyName, xmsCHAR16 *propertyValue, xmsHErrorBlock errorBlock);
Get the value of the 2-byte character property identified by name.
xmsRC xmsGetDoubleProperty(xmsHObj object, xmsCHAR *propertyName, xmsDOUBLE *propertyValue, xmsHErrorBlock errorBlock);
Get the value of the double precision floating point property identified by name.
xmsRC xmsGetFloatProperty(xmsHObj object, xmsCHAR *propertyName, xmsFLOAT *propertyValue, xmsHErrorBlock errorBlock);
Get the value of the floating point property identified by name.
xmsRC xmsGetHandleTypeId(xmsHObj object, xmsHANDLE_TYPE *handleType, xmsHErrorBlock errorBlock);
Get the type of the handle for the object.
xmsRC xmsGetIntProperty(xmsHObj object, xmsCHAR *propertyName, xmsINT *propertyValue, xmsHErrorBlock errorBlock);
Get the value of the integer property identified by name.
xmsRC xmsGetLongProperty(xmsHObj object, xmsCHAR *propertyName, xmsLONG *propertyValue, xmsHErrorBlock errorBlock);
Get the value of the long integer property identified by name.
xmsRC xmsGetObjectProperty(xmsHObj object, xmsCHAR *propertyName, xmsSBYTE *propertyValue, xmsINT length, xmsINT *actualLength, xmsOBJECT_TYPE *objectType, xmsHErrorBlock errorBlock);
Get the value and data type of the property identified by name.
For more information about how to use this function, see C functions that return a byte array by value.
xmsRC xmsGetProperty(xmsHObj object, xmsCHAR *propertyName, xmsHProperty *property, xmsHErrorBlock errorBlock);
Get a Property object for the property identified by name.
xmsRC xmsGetShortProperty(xmsHObj object, xmsCHAR *propertyName, xmsLONG *propertyValue, xmsHErrorBlock errorBlock);
Get the value of the short integer property identified by name.
xmsRC xmsGetStringProperty(xmsHObj object, xmsCHAR *propertyName, xmsCHAR *propertyValue, xmsINT length, xmsINT *actualLength, xmsHErrorBlock errorBlock);
Get the value of the string property identified by name.
For more information about how to use this function, see C functions that return a string by value.
xmsRC xmsMsgGetStringPropertyByRef(xmsHObj object, xmsCHAR *propertyName, xmsCHAR **propertyValue, xmsINT *length, xmsHErrorBlock errorBlock);
Get a pointer to the value of the string property identified by name.
For more information about how to use this function, see C functions that return a string or byte array by reference.
Note that the value of the property must be a string. The function makes no attempt to convert a value with another data type into a string. If an application calls this function to get a pointer to a value that is not a string, XMS returns error code XMS_E_TYPE_CONVERSION_FAILED.
xmsRC xmsSetBooleanProperty(xmsHObj object, xmsCHAR *propertyName, xmsBOOL propertyValue, xmsHErrorBlock errorBlock);
Set the value of the boolean property identified by name.
xmsRC xmsSetByteProperty(xmsHObj object, xmsCHAR *propertyName, xmsSBYTE propertyValue, xmsHErrorBlock errorBlock);
Set the value of the byte property identified by name.
xmsRC xmsSetByteArrayProperty(xmsHObj object, xmsCHAR *propertyName, xmsSBYTE *propertyValue, xmsINT length xmsHErrorBlock errorBlock);
Set the value of the byte array property identified by name.
xmsRC xmsSetCharProperty(xmsHObj object, xmsCHAR *propertyName, xmsCHAR16 propertyValue, xmsHErrorBlock errorBlock);
Set the value of the 2-byte character property identified by name.
xmsRC xmsSetDoubleProperty(xmsHObj object, xmsCHAR *propertyName, xmsDOUBLE propertyValue, xmsHErrorBlock errorBlock);
Set the value of the double precision floating point property identified by name.
xmsRC xmsSetFloatProperty(xmsHObj object, xmsCHAR *propertyName, xmsFLOAT propertyValue, xmsHErrorBlock errorBlock);
Set the value of the floating point property identified by name.
xmsRC xmsSetIntProperty(xmsHObj object, xmsCHAR *propertyName, xmsINT propertyValue, xmsHErrorBlock errorBlock);
Set the value of the integer property identified by name.
xmsRC xmsSetLongProperty(xmsHObj object, xmsCHAR *propertyName, xmsLONG propertyValue, xmsHErrorBlock errorBlock);
Set the value of the long integer property identified by name.
xmsRC xmsSetObjectProperty(xmsHObj object, xmsCHAR *propertyName, xmsSBYTE *propertyValue, xmsINT length, xmsOBJECT_TYPE objectType, xmsHErrorBlock errorBlock);
Set the value and data type of a property identified by name.
xmsRC xmsSetProperty(xmsHObj object, xmsHProperty property, xmsHErrorBlock errorBlock);
Set the value of a property using a Property object.
xmsRC xmsSetShortProperty(xmsHObj object, xmsCHAR *propertyName, xmsSHORT propertyValue, xmsHErrorBlock errorBlock);
Set the value of the short integer property identified by name.
xmsRC xmsSetStringProperty(xmsHObj object, xmsCHAR *propertyName, xmsCHAR *propertyValue, xmsINT length, xmsHErrorBlock errorBlock);
Set the value of the string property identified by name.