Skip navigation.
Downloads | Product Documentation | Support

# JmsTextMessage.h File Reference

Describes a JmsTextMessage handle. More...

`#include <JmsCommon.h>`
`#include <JmsSession.h>`
`#include <JmsMessage.h>`
`#include <JmsTypes.h>`

Go to the source code of this file.

## Typedefs
typedef JmsMessage | JmsTextMessage
## Functions
int JMSENTRY | JmsSessionTextMessageCreate (JmsSession *session, JmsString *text, JmsTextMessage **message, JMS64I flags)
int JMSENTRY | JmsTextMessageSetText (JmsTextMessage *message, JmsString *text, JMS64I flags)
int JMSENTRY | JmsTextMessageGetText (JmsTextMessage *message, JmsString *text, JMS64I flags)

## Detailed Description

Describes a JmsTextMessage handle.

This file describes the functions that can be performed on a JmsTextMessage handle A JmsTextMessage handle corresponds to javax.jms.TextMessage

Author:
  Copyright (c) 2002, BEA Systems, Inc.

## Typedef Documentation

typedef JmsMessage JmsTextMessage

| A text message handle that represents the class javax.jms.TextMessage

## Function Documentation

int JMSENTRY JmsSessionTextMessageCreate | ( | JmsSession * | session,
|  | JmsString * | text,
|  | JmsTextMessage ** | message,
|  | JMS64I | flags
| ) |

  | Gets a text message handle from the given session handle Parameters:
  session | Must be a valid session handle. May not be NULL
  text | The text to use for this text message handle. If NULL then no text is associated with the handle
  message | May not be NULL. On success, *message will contain a valid text message handle
  flags | Reserved for future use. Must be zero
Returns: JMS_NO_ERROR JMS_GOT_EXCEPTION JMS_INPUT_PARAM_ERROR JMS_MALLOC_ERROR JMS_JVM_ERROR

int JMSENTRY JmsTextMessageGetText | ( | JmsTextMessage * | message,
|  | JmsString * | text,
|  | JMS64I | flags
| ) |

  | Gets the text of a text message handle Parameters:
  message | Must be a valid text message handle. May not be NULL
  text | May not be NULL. On success will contain the text of the text message handle
  flags | Reserved for future use. Must be zero
Returns: JMS_NO_ERROR JMS_GOT_EXCEPTION JMS_INPUT_PARAM_ERROR JMS_MALLOC_ERROR JMS_JVM_ERROR JMS_NEED_SPACE

int JMSENTRY JmsTextMessageSetText | ( | JmsTextMessage * | message,
|  | JmsString * | text,
|  | JMS64I | flags
| ) |

  | Sets the text of a text message handle Parameters:
  message | Must be a valid text message handle. May not be NULL
  text | The text to use for this text message handle. May not be NULL
  flags | Reserved for future use. Must be zero
Returns: JMS_NO_ERROR JMS_GOT_EXCEPTION JMS_INPUT_PARAM_ERROR JMS_MALLOC_ERROR JMS_JVM_ERROR