Skip navigation.
Downloads | Product Documentation | Support

# JmsMetaData.h File Reference

Describes a JmsMetaData handle. More...

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

Go to the source code of this file.

## Typedefs
typedef JmsMetaData | JmsMetaData
## Functions
int JMSENTRY | JmsMetaDataDestroy (JmsMetaData *metaData, JMS64I flags)
int JMSENTRY | JmsMetaDataGetJMSVersion (JmsMetaData *metaData, JmsString *versionString, JMS64I flags)
int JMSENTRY | JmsMetaDataGetJMSVersionMajor (JmsMetaData *metaData, int *versionMajor, JMS64I flags)
int JMSENTRY | JmsMetaDataGetJMSVersionMinor (JmsMetaData *metaData, int *versionMinor, JMS64I flags)
int JMSENTRY | JmsMetaDataGetProviderName (JmsMetaData *metaData, JmsString *name, JMS64I flags)
int JMSENTRY | JmsMetaDataGetVersion (JmsMetaData *metaData, JmsString *versionString, JMS64I flags)
int JMSENTRY | JmsMetaDataGetVersionMajor (JmsMetaData *metaData, int *versionMajor, JMS64I flags)
int JMSENTRY | JmsMetaDataGetVersionMinor (JmsMetaData *metaData, int *versionMinor, JMS64I flags)

## Detailed Description

Describes a JmsMetaData handle.

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

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

## Typedef Documentation

typedef struct JmsMetaData JmsMetaData

| A message handle that represents the class javax.jms.MetaData

## Function Documentation

int JMSENTRY JmsMetaDataDestroy | ( | JmsMetaData * | metaData,
|  | JMS64I | flags
| ) |

  | Destroys the meta data handle. After a call to this function the meta data handle is no longer valid and should not be referenced Parameters:
  metaData | Must be a valid metaData 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

int JMSENTRY JmsMetaDataGetJMSVersion | ( | JmsMetaData * | metaData,
|  | JmsString * | versionString,
|  | JMS64I | flags
| ) |

  | Gets the version of JMS this connection supports as a string Parameters:
  metaData | Must be a valid metaData handle. May not be NULL
  versionString | May not be NULL. On success will contain the JMS version as a string
  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 JmsMetaDataGetJMSVersionMajor | ( | JmsMetaData * | metaData,
|  | int * | versionMajor,
|  | JMS64I | flags
| ) |

  | Gets the major version of JMS this connection supports Parameters:
  metaData | Must be a valid metaData handle. May not be NULL
  versionMajor | May not be NULL. On success, *versionMajor will contain the JMS major version
  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 JmsMetaDataGetJMSVersionMinor | ( | JmsMetaData * | metaData,
|  | int * | versionMinor,
|  | JMS64I | flags
| ) |

  | Gets the minor version of JMS this connection supports Parameters:
  metaData | Must be a valid metaData handle. May not be NULL
  versionMinor | May not be NULL. On success, *versionMinor will contain the JMS minor version
  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 JmsMetaDataGetProviderName | ( | JmsMetaData * | metaData,
|  | JmsString * | name,
|  | JMS64I | flags
| ) |

  | Gets the name of the JMS Provider from the meta data handle Parameters:
  metaData | Must be a valid metaData handle. May not be NULL
  name | May not be NULL. On success will contain the name of the JMS provider
  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 JmsMetaDataGetVersion | ( | JmsMetaData * | metaData,
|  | JmsString * | versionString,
|  | JMS64I | flags
| ) |

  | Gets the provider version of JMS this connection supports as a string Parameters:
  metaData | Must be a valid metaData handle. May not be NULL
  versionString | May not be NULL. On success will contain the provider version as a string
  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 JmsMetaDataGetVersionMajor | ( | JmsMetaData * | metaData,
|  | int * | versionMajor,
|  | JMS64I | flags
| ) |

  | Gets the major version of the provider from the meta data handle Parameters:
  metaData | Must be a valid metaData handle. May not be NULL
  versionMajor | May not be NULL. On success, *versionMajor will contain the provider's major version
  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 JmsMetaDataGetVersionMinor | ( | JmsMetaData * | metaData,
|  | int * | versionMinor,
|  | JMS64I | flags
| ) |

  | Gets the minor version of the provider from the meta data handle Parameters:
  metaData | Must be a valid metaData handle. May not be NULL
  versionMinor | May not be NULL. On success, *versionMinor will contain the provider's minor version
  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