Content starts here JMS C API Reference for Oracle WebLogic Server
Skip navigation.
Main Page  |  Data Structures  |  File List  |  Data Fields  |  Globals

JmsMapMessage.h File Reference

Describes a JmsMapMessage handle. More...

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

Go to the source code of this file.


Typedefs

typedef JmsMessage JmsMapMessage

Functions

int JMSENTRY JmsSessionMapMessageCreate (JmsSession *session, JmsMapMessage **message, JMS64I flags)
int JMSENTRY JmsMapMessageGetBoolean (JmsMapMessage *message, JmsString *name, int *value, JMS64I flags)
int JMSENTRY JmsMapMessageGetByte (JmsMapMessage *message, JmsString *name, unsigned char *value, JMS64I flags)
int JMSENTRY JmsMapMessageGetChar (JmsMapMessage *message, JmsString *name, short *value, JMS64I flags)
int JMSENTRY JmsMapMessageGetShort (JmsMapMessage *message, JmsString *name, short *value, JMS64I flags)
int JMSENTRY JmsMapMessageGetInt (JmsMapMessage *message, JmsString *name, JMS32I *value, JMS64I flags)
int JMSENTRY JmsMapMessageGetLong (JmsMapMessage *message, JmsString *name, JMS64I *value, JMS64I flags)
int JMSENTRY JmsMapMessageGetFloat (JmsMapMessage *message, JmsString *name, float *value, JMS64I flags)
int JMSENTRY JmsMapMessageGetDouble (JmsMapMessage *message, JmsString *name, double *value, JMS64I flags)
int JMSENTRY JmsMapMessageGetString (JmsMapMessage *message, JmsString *name, JmsString *value, JMS64I flags)
int JMSENTRY JmsMapMessageGetBytes (JmsMapMessage *message, JmsString *name, void *bytes, JMS32I *length, JMS64I flags)
int JMSENTRY JmsMapMessageGetNames (JmsMapMessage *message, JmsEnumeration **enumeration, JMS64I flags)
int JMSENTRY JmsMapMessageSetBoolean (JmsMapMessage *message, JmsString *name, int value, JMS64I flags)
int JMSENTRY JmsMapMessageSetByte (JmsMapMessage *message, JmsString *name, unsigned char value, JMS64I flags)
int JMSENTRY JmsMapMessageSetShort (JmsMapMessage *message, JmsString *name, short value, JMS64I flags)
int JMSENTRY JmsMapMessageSetChar (JmsMapMessage *message, JmsString *name, short value, JMS64I flags)
int JMSENTRY JmsMapMessageSetInt (JmsMapMessage *message, JmsString *name, JMS32I value, JMS64I flags)
int JMSENTRY JmsMapMessageSetLong (JmsMapMessage *message, JmsString *name, JMS64I value, JMS64I flags)
int JMSENTRY JmsMapMessageSetFloat (JmsMapMessage *message, JmsString *name, float value, JMS64I flags)
int JMSENTRY JmsMapMessageSetDouble (JmsMapMessage *message, JmsString *name, double value, JMS64I flags)
int JMSENTRY JmsMapMessageSetString (JmsMapMessage *message, JmsString *name, JmsString *value, JMS64I flags)
int JMSENTRY JmsMapMessageSetBytes (JmsMapMessage *message, JmsString *name, void *value, JMS32I length, JMS64I flags)
int JMSENTRY JmsMapMessageItemExists (JmsMapMessage *message, JmsString *name, int *boolean, JMS64I flags)

Detailed Description

Describes a JmsMapMessage handle.

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

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

Typedef Documentation

typedef JmsMessage JmsMapMessage
 

A map message handle that represents the class javax.jms.MapMessage

Function Documentation

int JMSENTRY JmsMapMessageGetBoolean (  JmsMapMessage *    message,
JmsString *    name,
int *    value,
JMS64I    flags
) 
 

Gets a boolean value of the given tag name from a map message handle

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to retrieve
value  May not be NULL. On success, *value will contain the boolean value with the given tag name
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 JmsMapMessageGetByte (  JmsMapMessage *    message,
JmsString *    name,
unsigned char *    value,
JMS64I    flags
) 
 

Gets a byte value of the given tag name from a map message handle

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to retrieve
value  May not be NULL. On success, *value will contain the byte value with the given tag name
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 JmsMapMessageGetBytes (  JmsMapMessage *    message,
JmsString *    name,
void *    bytes,
JMS32I *    length,
JMS64I    flags
) 
 

Gets a byte array value of the given tag name from a map message handle

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to retrieve
bytes  May not be NULL. Must have at least *length bytes to be written into. On success this array will be filled in up to *length bytes
length  May not be NULL. On input, *length must contain the number of bytes that can be written to bytes. If the return is JMS_NEED_SPACE then *length will contain the number of bytes necessary to get the complete byte array and bytes will have been filled in as much as possible. On success, *length will contain the actual number of bytes written to bytes
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 JmsMapMessageGetChar (  JmsMapMessage *    message,
JmsString *    name,
short *    value,
JMS64I    flags
) 
 

Gets a two byte java character value of the given tag name from a map message handle

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to retrieve
value  May not be NULL. On success, *value will contain the two byte java character value with the given tag name
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 JmsMapMessageGetDouble (  JmsMapMessage *    message,
JmsString *    name,
double *    value,
JMS64I    flags
) 
 

Gets a double value of the given tag name from a map message handle

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to retrieve
value  May not be NULL. On success, *value will contain the double value with the given tag name
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 JmsMapMessageGetFloat (  JmsMapMessage *    message,
JmsString *    name,
float *    value,
JMS64I    flags
) 
 

Gets a float value of the given tag name from a map message handle

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to retrieve
value  May not be NULL. On success, *value will contain the float value with the given tag name
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 JmsMapMessageGetInt (  JmsMapMessage *    message,
JmsString *    name,
JMS32I *    value,
JMS64I    flags
) 
 

Gets an integer value of the given tag name from a map message handle

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to retrieve
value  May not be NULL. On success, *value will contain the integer value with the given tag name
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 JmsMapMessageGetLong (  JmsMapMessage *    message,
JmsString *    name,
JMS64I *    value,
JMS64I    flags
) 
 

Gets a long value of the given tag name from a map message handle

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to retrieve
value  May not be NULL. On success, *value will contain the long value with the given tag name
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 JmsMapMessageGetNames (  JmsMapMessage *    message,
JmsEnumeration **    enumeration,
JMS64I    flags
) 
 

Gets an enumeration handle containing the names of all the tags in this map message handle

Parameters:
message  Must be a valid map message handle. May not be NULL
enumeration  May not be NULL. On success, *enumeration will contain a valid enumeration handle. The value parameter of JmsEnumerationNextElement should be a JmsString ** with this enumeration.
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 JmsMapMessageGetShort (  JmsMapMessage *    message,
JmsString *    name,
short *    value,
JMS64I    flags
) 
 

Gets a short value of the given tag name from a map message handle

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to retrieve
value  May not be NULL. On success, *value will contain the short value with the given tag name
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 JmsMapMessageGetString (  JmsMapMessage *    message,
JmsString *    name,
JmsString *    value,
JMS64I    flags
) 
 

Gets a string value of the given tag name from a map message handle

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to retrieve
value  May not be NULL. On success, will contain the string value with the given tag name
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 JmsMapMessageItemExists (  JmsMapMessage *    message,
JmsString *    name,
int *    boolean,
JMS64I    flags
) 
 

Tells whether or not a given tag name exists on the map message handles

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to query
boolean  May not be NULL. On success, *boolean will be zero if the tag name does not exist on the message and will be non-zero if the tag name does exist
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 JmsMapMessageSetBoolean (  JmsMapMessage *    message,
JmsString *    name,
int    value,
JMS64I    flags
) 
 

Sets a boolean value with the given tag name on a map message

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to set
value  The boolean value to set on the map 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 JmsMapMessageSetByte (  JmsMapMessage *    message,
JmsString *    name,
unsigned char    value,
JMS64I    flags
) 
 

Sets a byte value with the given tag name on a map message

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to set
value  The byte value to set on the map 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 JmsMapMessageSetBytes (  JmsMapMessage *    message,
JmsString *    name,
void *    value,
JMS32I    length,
JMS64I    flags
) 
 

Sets a byte array value with the given tag name on a map message

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to set
value  The byte array to set on the map message handle
length  The number of bytes to write from bytes
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 JmsMapMessageSetChar (  JmsMapMessage *    message,
JmsString *    name,
short    value,
JMS64I    flags
) 
 

Sets a two byte java character value with the given tag name on a map message

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to set
value  The two byte java character value to set on the map 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 JmsMapMessageSetDouble (  JmsMapMessage *    message,
JmsString *    name,
double    value,
JMS64I    flags
) 
 

Sets a double value with the given tag name on a map message

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to set
value  The double value to set on the map 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 JmsMapMessageSetFloat (  JmsMapMessage *    message,
JmsString *    name,
float    value,
JMS64I    flags
) 
 

Sets a float value with the given tag name on a map message

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to set
value  The float value to set on the map 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 JmsMapMessageSetInt (  JmsMapMessage *    message,
JmsString *    name,
JMS32I    value,
JMS64I    flags
) 
 

Sets an integer value with the given tag name on a map message

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to set
value  The integer value to set on the map 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 JmsMapMessageSetLong (  JmsMapMessage *    message,
JmsString *    name,
JMS64I    value,
JMS64I    flags
) 
 

Sets a long value with the given tag name on a map message

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to set
value  The long value to set on the map 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 JmsMapMessageSetShort (  JmsMapMessage *    message,
JmsString *    name,
short    value,
JMS64I    flags
) 
 

Sets a short value with the given tag name on a map message

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to set
value  The short value to set on the map 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 JmsMapMessageSetString (  JmsMapMessage *    message,
JmsString *    name,
JmsString *    value,
JMS64I    flags
) 
 

Sets a string value with the given tag name on a map message

Parameters:
message  Must be a valid map message handle. May not be NULL
name  The tag name to set
value  The string value to set on the map 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 JmsSessionMapMessageCreate (  JmsSession *    session,
JmsMapMessage **    message,
JMS64I    flags
) 
 

Gets a map message handle from the given session handle

Parameters:
session  Must be a valid session handle. May not be NULL
message  May not be NULL. On success, *message will contain a valid map 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
Copyright 1996,2016. Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
JMS C API Reference for Oracle WebLogic Server
12c (12.2.1.2.0)

Part Number E78005-01

Generated by doxygen 1.2.18