WebSphere Message Service Client for C/C++, Version 2.0.2 Operating Systems: AIX, Linux, Solaris, Windows

PropertyContext

PropertyContext is an abstract superclass that contains methods that get and set properties. These methods are inherited by other classes.

Inheritance hierarchy:
None

Methods

Summary of methods:
Method Description
getBooleanProperty Get the value of the boolean property identified by name.
getByteProperty Get the value of the byte property identified by name.
getBytesProperty Get the value of the byte array property identified by name.
getCharProperty Get the value of the 2-byte character property identified by name.
getDoubleProperty Get the value of the double precision floating point property identified by name.
getFloatProperty Get the value of the floating point property identified by name.
getIntProperty Get the value of the integer property identified by name.
getLongProperty Get the value of the long integer property identified by name.
getObjectProperty Get the value and data type of the property identified by name.
getProperty Get a Property object for the property identified by name.
getShortProperty Get the value of the short integer property identified by name.
getStringProperty Get the value of the string property identified by name.
setBooleanProperty Set the value of the boolean property identified by name.
setByteProperty Set the value of the byte property identified by name.
setBytesProperty Set the value of the byte array property identified by name.
setCharProperty Set the value of the 2-byte character property identified by name.
setDoubleProperty Set the value of the double precision floating point property identified by name.
setFloatProperty Set the value of the floating point property identified by name.
setIntProperty Set the value of the integer property identified by name.
setLongProperty Set the value of the long integer property identified by name.
setObjectProperty Set the value and data type of a property identified by name.
setProperty Set the value of a property using a Property object.
setShortProperty Set the value of the short integer property identified by name.
setStringProperty Set the value of the string property identified by name.

getBooleanProperty – Get Boolean Property

Interface:
xmsBOOL getBooleanProperty(const String & propertyName) const;

Get the value of the boolean property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
Returns:
The value of the property.
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getByteProperty – Get Byte Property

Interface:
xmsSBYTE getByteProperty(const String & propertyName) const;

Get the value of the byte property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
Returns:
The value of the property.
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getBytesProperty – Get Byte Array Property

Interface:
xmsINT getBytesProperty(const String & propertyName,
                        xmsSBYTE *propertyValue,
                        const xmsINT length,
                        xmsINT *actualLength) const;

Get the value of the byte array property identified by name.

For more information about how to use this method, see C++ methods that return a byte array.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
propertyValue (output)
The buffer to contain the value of the property, which is an array of bytes.
length (input)
The length of the buffer in bytes. If you specify XMSC_QUERY_SIZE instead, the array of bytes is not returned, but its length is returned in the actualLength parameter.
actualLength (output)
The number of bytes in the array. If you specify a null pointer on input, the length of the array is not returned.
Returns:
The number of bytes in the array.
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getCharProperty – Get Character Property

Interface:
xmsCHAR16 getCharProperty(const String & propertyName) const;

Get the value of the 2-byte character property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
Returns:
The value of the property.
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getDoubleProperty – Get Double Precision Floating Point Property

Interface:
xmsDOUBLE getDoubleProperty(const String & propertyName) const;

Get the value of the double precision floating point property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
Returns:
The value of the property.
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getFloatProperty – Get Floating Point Property

Interface:
xmsFLOAT getFloatProperty(const String & propertyName) const;

Get the value of the floating point property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
Returns:
The value of the property.
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getIntProperty – Get Integer Property

Interface:
xmsINT getIntProperty(const String & propertyName) const;

Get the value of the integer property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
Returns:
The value of the property.
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getLongProperty – Get Long Integer Property

Interface:
xmsLONG getLongProperty(const String & propertyName) const;

Get the value of the long integer property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
Returns:
The value of the property.
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getObjectProperty – Get Object Property

Interface:
xmsOBJECT_TYPE getObjectProperty(const String & propertyName,
                                 xmsSBYTE *propertyValue,
                                 const xmsINT length,
                                 xmsINT *actualLength);

Get the value and data type of the property identified by name.

For more information about how to use this method, see C++ methods that return a byte array.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
propertyValue (output)
The buffer to contain the value of the property, which is returned as an array of bytes. If the value is a string and 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 value of the property is not returned, but its length is returned in the actualLength parameter.
actualLength (output)
The length of the value of the property in bytes. If the value is a string and data conversion is required, this is the length after conversion. If you specify a null pointer on input, the length is not returned.
Returns:
The data type of the value of the property, which is one of the following object types:
  • XMS_OBJECT_TYPE_BOOL
  • XMS_OBJECT_TYPE_BYTE
  • XMS_OBJECT_TYPE_BYTEARRAY
  • XMS_OBJECT_TYPE_CHAR
  • XMS_OBJECT_TYPE_DOUBLE
  • XMS_OBJECT_TYPE_FLOAT
  • XMS_OBJECT_TYPE_INT
  • XMS_OBJECT_TYPE_LONG
  • XMS_OBJECT_TYPE_SHORT
  • XMS_OBJECT_TYPE_STRING
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getProperty – Get Property

Interface:
virtual Property getProperty(const String & propertyName) const;

Get a Property object for the property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
Returns:
The Property object.
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getShortProperty – Get Short Integer Property

Interface:
xmsSHORT getShortProperty(const String & propertyName) const;

Get the value of the short integer property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
Returns:
The value of the property.
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getStringProperty – Get String Property

Interface:
String getStringProperty(const String & propertyName) const;

Get the value of the string property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
Returns:
A String object encapsulating the string that is the value of the property. If data conversion is required, this is the string after conversion.
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

setBooleanProperty – Set Boolean Property

Interface:
xmsVOID setBooleanProperty(const String & propertyName,
                           const xmsBOOL propertyValue);

Set the value of the boolean property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
propertyValue (input)
The value of the property.
Returns:
Void
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

setByteProperty – Set Byte Property

Interface:
xmsVOID setByteProperty(const String & propertyName,
                        const xmsSBYTE propertyValue);

Set the value of the byte property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
propertyValue (input)
The value of the property.
Returns:
Void
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

setBytesProperty – Set Byte Array Property

Interface:
xmsVOID setBytesProperty(const String & propertyName,
                         const xmsSBYTE *propertyValue,
                         const xmsINT length);

Set the value of the byte array property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
propertyValue (input)
The value of the property, which is an array of bytes.
length (input)
The number of bytes in the array.
Returns:
Void
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

setCharProperty – Set Character Property

Interface:
xmsVOID setCharProperty(const String & propertyName,
                        const xmsCHAR16 propertyValue);

Set the value of the 2-byte character property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
propertyValue (input)
The value of the property.
Returns:
Void
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

setDoubleProperty – Set Double Precision Floating Point Property

Interface:
xmsVOID setDoubleProperty(const String & propertyName,
                          const xmsDOUBLE propertyValue);

Set the value of the double precision floating point property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
propertyValue (input)
The value of the property.
Returns:
Void
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

setFloatProperty – Set Floating Point Property

Interface:
xmsVOID setFloatProperty(const String & propertyName,
                         const xmsFLOAT propertyValue);

Set the value of the floating point property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
propertyValue (input)
The value of the property.
Returns:
Void
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

setIntProperty – Set Integer Property

Interface:
xmsVOID setIntProperty(const String & propertyName,
                       const xmsINT propertyValue);

Set the value of the integer property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
propertyValue (input)
The value of the property.
Returns:
Void
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

setLongProperty – Set Long Integer Property

Interface:
xmsVOID setLongProperty(const String & propertyName,
                        const xmsLONG propertyValue);

Set the value of the long integer property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
propertyValue (input)
The value of the property.
Returns:
Void
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

setObjectProperty – Set Object Property

Interface:
xmsVOID setObjectProperty(const String & propertyName,
                          const xmsOBJECT_TYPE objectType,
                          const xmsSBYTE *propertyValue,
                          const xmsINT length);

Set the value and data type of a property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
objectType (input)
The data type of the value of the property, which must be one of the following object types:
  • XMS_OBJECT_TYPE_BOOL
  • XMS_OBJECT_TYPE_BYTE
  • XMS_OBJECT_TYPE_BYTEARRAY
  • XMS_OBJECT_TYPE_CHAR
  • XMS_OBJECT_TYPE_DOUBLE
  • XMS_OBJECT_TYPE_FLOAT
  • XMS_OBJECT_TYPE_INT
  • XMS_OBJECT_TYPE_LONG
  • XMS_OBJECT_TYPE_SHORT
  • XMS_OBJECT_TYPE_STRING
propertyValue (input)
The value of the property as an array of bytes.
length (input)
The number of bytes in the array.
Returns:
Void
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

setProperty – Set Property

Interface:
virtual xmsVOID setProperty(const Property & property);

Set the value of a property using a Property object.

Parameters:
property (input)
The Property object.
Returns:
Void
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

setShortProperty – Set Short Integer Property

Interface:
xmsVOID setShortProperty(const String & propertyName,
                         const xmsSHORT propertyValue);

Set the value of the short integer property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
propertyValue (input)
The value of the property.
Returns:
Void
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

setStringProperty – Set String Property

Interface:
xmsVOID setStringProperty(const String & propertyName,
                          const String & propertyValue);

Set the value of the string property identified by name.

Parameters:
propertyName (input)
A String object encapsulating the name of the property.
propertyValue (input)
A String object encapsulating the string that is the value of the property.
Returns:
Void
Thread context:
Determined by the subclass
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

Reference topic

Terms of Use | Rate this page

Last updated: 24 May 2011

(C) Copyright IBM Corporation 2005, 2011. All Rights Reserved.