tibemsMsg_SetMessageID

Function

Purpose

Set the message ID header of a message.

C Declaration

tibems_status tibemsMsg_SetMessageID(
    tibemsMsg message,
    const char* value );

COBOL Call

CALL "tibemsMsg_SetMessageID"
     USING BY VALUE message,
           BY REFERENCE value,
           RETURNING tibems-status
END-CALL.
Note: message has usage pointer.

Parameters

Parameter Description
message Set the message ID of this message.
value Set the message ID to this value.

Remarks

Sending calls set the message ID header automatically. The JMS specification defines this call for symmetry.

Sending calls assign a unique ID to each message, and record it in this header.

All message ID values start with the 3-character prefix ID: (which is reserved for this purpose).

Applications that do not require message IDs can reduce overhead costs by disabling IDs; see tibemsMsgProducer_SetDisableMessageID. When the producer disables IDs, the value of this header is null.

See Also

tibemsMsg_GetCorrelationID

tibemsMsg_GetMessageID

tibemsMsg_SetCorrelationID

tibemsMsgProducer_SetDisableMessageID