tibemsMsg_Recover

Function

Purpose

Recover a single message.

C Declaration

tibems_status tibemsMsg_Recover(
    tibemsMsg message );

COBOL Call

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

Parameters

Parameter Description
message Recover the specified message.

Remarks

When the application calls this function, TIBCO Enterprise Message Service puts this message back on the queue or topic and makes it available for redelivery. The JMSRedelivered header is set to true.

This call is only legal for the TIBEMS_EXPLICIT_CLIENT_ACKNOWLEDGE and TIBEMS_EXPLICIT_CLIENT_DUPS_OK_ACKNOWLEDGE acknowledgment modes. In all other modes, this call returns TIBEMS_ILLEGAL_STATE.

This function recovers only the specified message. To recover all unacknowledged messages from a session, use tibemsSession_Recover.

Restriction

It is illegal to call this function on an acknowledged message or on a message that is included in a transaction.

Additionally, it is illegal to call this function twice on the same message, or again on a message that was previously recovered using tibemsSession_Recover.

See Also

tibemsSession_Recover

tibemsAcknowledgeMode