WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 Operating Systems: Linux, Windows

TextMessage

A text message is a message whose body comprises a string.

Inheritance hierarchy:
xms::PropertyContext
   |
   +----xms::Message
           |
           +----xms::TextMessage
Related reference
Text messages

Methods

Summary of methods:
Method Description
getText Get the string that forms the body of the text message.
setText Set the string that forms the body of the text message.

getText – get Text

Interface:
String getText() const;

Get the string that forms the body of the text message. If required, XMS converts the characters in the string into the local code page.

Parameters:
None
Returns:
A String object encapsulating the string that is read. If data conversion is required, this is the string after conversion.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION

setText – Set Text

Interface:
xmsVOID setText(const String & value);

Set the string that forms the body of the text message.

Parameters:
value (input)
A String object encapsulating the string to be set.
Returns:
Void
Exceptions:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

Inherited methods


Reference topic

Terms of Use | Rate this page

Last updated: 7 Dec 2005

© Copyright IBM Corporation 2005. All Rights Reserved.