tibrvMsg_Reset()

Function

Declaration

tibrv_status tibrvMsg_Reset(
    tibrvMsg        message);

Purpose

Clear a message, preparing it for re-use.

Remarks

This function is the equivalent of tibrvMsg_Destroy(), followed immediately by tibrvMsg_Create()—except that the storage is not freed, but rather re-used.

When this function returns, the message has no fields; it is like a newly created message. The message’s address information is also reset.

Pointer data (such as strings, arrays, submessages, opaque byte sequences or XML data) previously extracted from fields of the old message are invalid.

Parameter	Description
message	Reset this message.

See Also

tibrvMsg_Create()

tibrvMsg_Destroy()