Skip navigation.
Downloads | Product Documentation | Support

# JmsCommon.h File Reference

Describes structures used by most of the JMS C API. More...

`#include <JmsTypes.h>`

Go to the source code of this file.

## Data Structures
struct | JmsString
## Defines
#define | JMS_CALLED_FROM_JMS (JMS64I) 0x0000000000000001
#define | JMS_APPLICATION_MUST_FREE_HANDLE (JMS64I) 0x0000000000000002
#define | CSTRING 0
#define | UNISTRING 1

## Detailed Description

Describes structures used by most of the JMS C API.

Author:
  Copyright (c) 2002, BEA Systems, Inc. Describes structures used by most of the JMS C API

## Define Documentation

#define CSTRING 0

| Indicates that a given string input or output is a NULL terminated UTF-8 encoded string

#define JMS_APPLICATION_MUST_FREE_HANDLE (JMS64I) 0x0000000000000002

| This flag indicates that the JMS subsystem should not free the input handle when the callback function returns. If this flag is set then it is the responsiblity of the application to free the handle that is passed into the callback function

#define JMS_CALLED_FROM_JMS (JMS64I) 0x0000000000000001

| This flag is set if a callback function is being called from the JMS C API. This flag is useful if the callback function might also be called from the application code.

#define UNISTRING 1

| Indicates that given input or output is a two-byte per character java string