WebSphere WebSphere Business Integration Message Service Clients for C/C++ Version 1.2.7 and .NET Version 1.2.6 Operating Systems: AIX, Linux, Solaris, Windows

Property

A Property object represents a property of an object.

A Property object has three attributes:
Property name
The name of the property
Property value
The value of the property
Property type
The data type of the value of the property

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.

Functions

Summary of functions:
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.

xmsPropertyCreate – Create Property (with no property value or property type)

Interface:
xmsRC xmsPropertyCreate(xmsCHAR *propertyName,
                        xmsHProperty *property,
                        xmsHErrorBlock errorBlock);

Create a Property object with no property value or property type.

Parameters:
propertyName (input)
The property name in the format of a null terminated string.
property (output)
The handle for the Property object.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyDispose – Delete Property

Interface:
xmsRC xmsPropertyDispose(xmsHProperty *property,
                         xmsHErrorBlock errorBlock);

Delete the Property object.

If an application tries to delete a Property object that is already deleted, the call is ignored.

Parameters:
property (input/output)
On input, the handle for the Property object. On output the function returns a null handle.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyDuplicate – Copy Property

Interface:
xmsRC xmsPropertyDuplicate(xmsHProperty property,
                           xmsHProperty *copiedProperty,
                           xmsHErrorBlock errorBlock);

Copy the Property object.

Parameters:
property (input)
The handle for the Property object.
copiedProperty (output)
The handle for the copy of the Property object.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetBoolean – Get Boolean Property Value

Interface:
xmsRC xmsPropertyGetBoolean(xmsHProperty property,
                            xmsBOOL *propertyValue,
                            xmsHErrorBlock errorBlock);

Get the boolean property value from the Property object.

Parameters:
property (input)
The handle for the Property object.
propertyValue (output)
The boolean property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetByte – Get Byte Property Value

Interface:
xmsRC xmsPropertyGetByte(xmsHProperty property,
                         xmsSBYTE *propertyValue,
                         xmsHErrorBlock errorBlock);

Get the byte property value from the Property object.

Parameters:
property (input)
The handle for the Property object.
propertyValue (output)
The byte property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetByteArray – Get Byte Array Property Value

Interface:
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.

Parameters:
property (input)
The handle for the Property object.
propertyValue (output)
The buffer to contain the property value, which is an array of bytes.
length (input)
The length of the buffer in bytes. If you specify XMSC_QUERY_SIZE instead, the property value is not returned, but its length is returned in the actualLength parameter.
actualLength (output)
The length of the property value in bytes. If you specify a null pointer on input, the length is not returned.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetByteArrayByRef – Get Byte Array Property Value by Reference

Interface:
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.

Parameters:
property (input)
The handle for the Property object.
propertyValue (output)
A pointer to the property value, which is an array of bytes.
length (output)
The length of the property value in bytes.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetChar – Get Character Property Value

Interface:
xmsRC xmsPropertyGetChar(xmsHProperty property,
                         xmsCHAR16 *propertyValue,
                         xmsHErrorBlock errorBlock);

Get the 2-byte character property value from the Property object.

Parameters:
property (input)
The handle for the Property object.
propertyValue (output)
The 2-byte character property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetDouble – Get Double Precision Floating Point Property Value

Interface:
xmsRC xmsPropertyGetDouble(xmsHProperty property,
                           xmsDOUBLE *propertyValue,
                           xmsHErrorBlock errorBlock);

Get the double precision floating point property value from the Property object.

Parameters:
property (input)
The handle for the Property object.
propertyValue (output)
The double precision floating point property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetFloat – Get Floating Point Property Value

Interface:
xmsRC xmsPropertyGetFloat(xmsHProperty property,
                          xmsFLOAT *propertyValue,
                          xmsHErrorBlock errorBlock);

Get the floating point property value from the Property object.

Parameters:
property (input)
The handle for the Property object.
propertyValue (output)
The floating point property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetInt – Get Integer Property Value

Interface:
xmsRC xmsPropertyGetInt(xmsHProperty property,
                        xmsINT *propertyValue,
                        xmsHErrorBlock errorBlock);

Get the integer property value from the Property object.

Parameters:
property (input)
The handle for the Property object.
propertyValue (output)
The integer property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetLong – Get Long Integer Property Value

Interface:
xmsRC xmsPropertyGetLong(xmsHProperty property,
                         xmsLONG *propertyValue,
                         xmsHErrorBlock errorBlock);

Get the long integer property value from the Property object.

Parameters:
property (input)
The handle for the Property object.
propertyValue (output)
The long integer property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetName – Get Property Name

Interface:
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.

Parameters:
property (input)
The handle for the Property object.
propertyName (output)
The buffer to contain the property name.
length (input)
The length of the buffer in bytes. If you specify XMSC_QUERY_SIZE instead, the property name is not returned, but its length is returned in the actualLength parameter.
actualLength (output)
The length of the property name in bytes. If you specify a null pointer on input, the length is not returned.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetShort – Get Short Integer Property Value

Interface:
xmsRC xmsPropertyGetShort(xmsHProperty property,
                          xmsSHORT *propertyValue,
                          xmsHErrorBlock errorBlock);

Get the short integer property value from the Property object.

Parameters:
property (input)
The handle for the Property object.
propertyValue (output)
The short integer property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetString – Get String Property Value

Interface:
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.

Parameters:
property (input)
The handle for the Property object.
propertyValue (output)
The buffer to contain the string property value. If data conversion is required, this is the value after conversion.
length (input)
The length of the buffer in bytes. If you specify XMSC_QUERY_SIZE instead, the property value is not returned, but its length is returned in the actualLength parameter.
actualLength (output)
The length of the property value in bytes. If data conversion is required, this is the length after conversion. If you specify a null pointer on input, the length is not returned.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetStringByRef – Get String Property Value by Reference

Interface:
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.

Parameters:
property (input)
The handle for the Property object.
propertyValue (output)
A pointer to the string property value. If data conversion is required, this is the value after conversion.

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.

length (output)
The length of the property value in bytes. If data conversion is required, this is the length after conversion.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetTypeId – Get Property Type

Interface:
xmsRC xmsPropertyGetTypeId(xmsHProperty property,
                           xmsPROPERTY_TYPE *propertyType,
                           xmsHErrorBlock errorBlock);

Get the property type from the Property object.

Parameters:
property (input)
The handle for the Property object.
propertyType (output)
The property type, which is one of the following values:
  • XMS_PROPERTY_TYPE_UNKNOWN
  • XMS_PROPERTY_TYPE_BOOL
  • XMS_PROPERTY_TYPE_BYTE
  • XMS_PROPERTY_TYPE_BYTEARRAY
  • XMS_PROPERTY_TYPE_CHAR
  • XMS_PROPERTY_TYPE_STRING
  • XMS_PROPERTY_TYPE_SHORT
  • XMS_PROPERTY_TYPE_INT
  • XMS_PROPERTY_TYPE_LONG
  • XMS_PROPERTY_TYPE_FLOAT
  • XMS_PROPERTY_TYPE_DOUBLE
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyIsTypeId – Check Property Type

Interface:
xmsRC xmsPropertyIsTypeId(xmsHProperty property,
                          xmsPROPERTY_TYPE propertyType,
                          xmsBOOL *isType,
                          xmsHErrorBlock errorBlock);

Check whether the Property object has the specified property type.

Parameters:
property (input)
The handle for the Property object.
propertyType (input)
The property type, which must be one of the following values:
  • XMS_PROPERTY_TYPE_UNKNOWN
  • XMS_PROPERTY_TYPE_BOOL
  • XMS_PROPERTY_TYPE_BYTE
  • XMS_PROPERTY_TYPE_BYTEARRAY
  • XMS_PROPERTY_TYPE_CHAR
  • XMS_PROPERTY_TYPE_STRING
  • XMS_PROPERTY_TYPE_SHORT
  • XMS_PROPERTY_TYPE_INT
  • XMS_PROPERTY_TYPE_LONG
  • XMS_PROPERTY_TYPE_FLOAT
  • XMS_PROPERTY_TYPE_DOUBLE
isType (output)
The value is xmsTRUE if the Property object has the specified property type. The value is xmsFALSE if the Property object does not have the specified property type.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetBoolean – Set Boolean Property Value

Interface:
xmsRC xmsPropertySetBoolean(xmsHProperty property,
                            xmsBOOL propertyValue,
                            xmsHErrorBlock errorBlock);

Set a boolean property value in the Property object and set the property type.

Parameters:
property (input)
The handle for the Property object.
propertyValue (input)
The boolean property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetByte – Set Byte Property Value

Interface:
xmsRC xmsPropertySetByte(xmsHProperty property,
                         xmsSBYTE propertyValue,
                         xmsHErrorBlock errorBlock);

Set a byte property value in the Property object and set the property type.

Parameters:
property (input)
The handle for the Property object.
propertyValue (input)
The byte property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetByteArray – Set Byte Array Property Value

Interface:
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.

Parameters:
property (input)
The handle for the Property object.
propertyValue (input)
The property value, which is an array of bytes.
length (input)
The length of the property value in bytes.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetChar – Set Character Property Value

Interface:
xmsRC xmsPropertySetChar(xmsHProperty Property,
                         xmsCHAR16 propertyValue,
                         xmsHErrorBlock errorBlock);

Set a 2-byte character property value in the Property object and set the property type.

Parameters:
property (input)
The handle for the Property object.
propertyValue (input)
The 2-byte character property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetDouble – Set Double Precision Floating Point Property Value

Interface:
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.

Parameters:
property (input)
The handle for the Property object.
propertyValue (input)
The double precision floating point property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetFloat – Set Floating Point Property Value

Interface:
xmsRC xmsPropertySetFloat(xmsHProperty property,
                          xmsFLOAT propertyValue,
                          xmsHErrorBlock errorBlock);

Set a floating point property value in the Property object and set the property type.

Parameters:
property (input)
The handle for the Property object.
propertyValue (input)
The floating point property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetInt – Set Integer Property Value

Interface:
xmsRC xmsPropertySetInt(xmsHProperty property,
                        xmsINT propertyValue,
                        xmsHErrorBlock errorBlock);

Set an integer property value in the Property object and set the property type.

Parameters:
property (input)
The handle for the Property object.
propertyValue (input)
The integer property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetLong – Set Long Integer Property Value

Interface:
xmsRC xmsPropertySetLong(xmsHProperty property,
                         xmsLONG propertyValue,
                         xmsHErrorBlock errorBlock);

Set a long integer property value in the Property object and set the property type.

Parameters:
property (input)
The handle for the Property object.
propertyValue (input)
The long integer property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetShort – Set Short Integer Property Value

Interface:
xmsRC xmsPropertySetShort(xmsHProperty property,
                          xmsSHORT propertyValue,
                          xmsHErrorBlock errorBlock);

Set a short integer property value in the Property object and set the property type.

Parameters:
property (input)
The handle for the Property object.
propertyValue (input)
The short integer property value.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetString – Set String Property Value

Interface:
xmsRC xmsPropertySetString(xmsHProperty property,
                           xmsCHAR *propertyValue,
                           xmsINT length,
                           xmsHErrorBlock errorBlock);

Set a string property value in the Property object and set the property type.

Parameters:
property (input)
The handle for the Property object.
propertyValue (input)
The string property value as a character array.
length (input)
The length of the property value in bytes. If the property value is null terminated with no embedded null characters, you can specify XMSC_CALCULATE_STRING_SIZE instead and allow XMS to calculate its length.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

Reference topic

Terms of Use | Rate this page

Last updated: 18 Jun 2008

© Copyright IBM Corporation 2005, 2008. All Rights Reserved.