tibemsMsg_SetCorrelationID


Function

Purpose

Set the correlation ID header of a message.

C Declaration

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

COBOL Call

CALL "tibemsMsg_SetCorrelationID" 
     USING BY VALUE message, 
           BY REFERENCE value, 
           RETURNING tibems-status 
END-CALL. 

message has usage pointer.

Parameters

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

Remarks

Correlation ID refers to a related message. For example, when a consumer responds to a request message by sending a reply, it can set the correlation ID of the reply to indicate the request message.

The JMS specification allows three categories of values for the correlation ID property:

See Also

tibemsMsg_GetCorrelationID

tibemsMsg_GetMessageID


TIBCO Enterprise Message Service™ C and COBOL Reference
System Release 4.3, February 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com