Parameter

Description

Queue Handle

Numeric (18). The numeric value that was returned from the Open program.

Timeout

Numeric (5). Input. (Milliseconds). This is the time that the component waits for a message. A value of zero (0) means infinite, meaning that the component waits until there is a message in the queue. This is the way to implement a listener.

Message

BLOB input that contains the message data. If the Message type is Map message or Stream message, the Message BLOB must contain the memory table described in the Buffer Table topic.

Message Type

Alpha (1). (Output). The valid values are:

• T: Text message. A Java language string object, such as the contents of an XML file.

• B: Bytes message. A stream of uninterpreted bytes, such as a BLOB.

• M: Map message. A set of name or value pairs, with string object names and primitive type values in the Java programming language. The order of the entries is irrelevant. See also Buffer Table.

• S: Stream message. A stream of Java defined primitive values. The supported primitive data types are: Boolean, Byte, Short, Char, Int, Long, Float, Double, String, Byte Array. The order of the data is important. See also Buffer Table.

• O: Object message. A Java serializable object.

• H: Header message. This message type only contains header fields and properties, and is useful when no message body is required.

Correlation Id

Alpha (200). Output that is defined by the application sending the message.

Get Only Custom Properties ?

Logical (Input). Defines whether to get custom properties only.

When set to False (default), all the Properties (JMS and Custom) will be returned in the output vectors.

When set to True, only Custom Properties will be returned in the output Vector.

Parameter Names

Vector of Alpha. (Output) Contains the message parameters' names.

Parameter Values

Vector of Alpha. (Output) Contains the message parameters' values.

Return value

Numeric. 0 for success and a negative value for failure.

Since version:

1.9j and 2.1