tibemsMsg_GetCorrelationID


Function

Purpose

Get the correlation ID header of a message.

C Declaration

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

COBOL Call

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

message and value have usage pointer.

Parameters

Parameter
Description
message
Get the correlation ID of this message.
value
The function stores the correlation ID in this location.

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_GetMessageID

tibemsMsg_SetCorrelationID


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