tibrvMsg_GetCMTimeLimit()

Function

Declaration

tibrv_status tibrvMsg_GetCMTimeLimit(
    tibrvMsg         message,
    tibrv_f64*       timeLimit);

Purpose

Extract the message time limit from a certified message.

Remarks

Programs can explicitly set the message time limit (see tibrvMsg_SetCMTimeLimit()).

Zero is a special value, indicating no time limit.

If a time limit is not set for a message, this function returns the status code TIBRV_NOT_FOUND. This situation can occur only for unsent outbound messages, and for inbound unlabeled messages.

Time limits represent the minimum time that certified delivery is in effect.

This value represents the total time limit of the message, not the time remaining.

Parameter

Description

message

Extract the time limit from this message.

timeLimit

The program supplies a location. The function stores the time limit in that location.

See Also

tibrvcmTransport_Send()

tibrvMsg_SetCMTimeLimit()