# tibemsMsg

Type

## Purpose

Messages that carry information among EMS client programs.

## Related Types

`tibemsBytesMsg`, `tibemsMapMsg`, `tibemsObjectMsg`, `tibemsStreamMsg`, `tibemsTextMsg`

Function | Description
--- | ---
Receipt
`tibemsMsg_Acknowledge` | Acknowledge messages.
Body
`tibemsMsg_GetBodyType` | Get the body type of a message.
Message Life Cycle
`tibemsMsg_ClearBody` | Clear the body of a message.
`tibemsMsg_ClearProperties` | Clear the properties of a message.
`tibemsMsg_Create` | Create a message object.
`tibemsMsg_CreateCopy` | Create a copy of the message object.
`tibemsMsg_CreateFromBytes` | Create a message object from data in a byte sequence.
`tibemsMsg_Destroy` | Destroy a message.
`tibemsMsg_MakeWriteable` | Make a message writeable.
`tibemsMsg_Recover` | Recover a single message.
Output
`tibemsMsg_GetAsBytes` | Get a byte sequence representation of the message object.
`tibemsMsg_GetAsBytesCopy` | Copy a byte sequence representation of the message object into storage supplied by the program.
`tibemsMsg_GetByteSize` | Compute the size of the byte sequence representation of the message.
`tibemsMsg_Print` | Print a message.
`tibemsMsg_PrintToBuffer` | Print a message into a buffer.
Headers and Properties For details, see `Headers`.
`tibemsMsg_ClearProperties` | Clear the properties of a message.
`tibemsMsg_GetCorrelationID` | Get the correlation ID header of a message.
`tibemsMsg_GetDeliveryMode` | Get the delivery mode header from a message.
`tibemsMsg_GetDeliveryTime` | Get the delivery time header from a message.
`tibemsMsg_GetDestination` | Get the destination header from a message.
`tibemsMsg_GetEncoding` | Get the character encoding header from a message.
`tibemsMsg_GetExpiration` | Get the expiration header from a message.
`tibemsMsg_GetMessageID` | Get the message ID header from a message.
`tibemsMsg_GetPriority` | Get the priority header from a message.
`tibemsMsg_Get Property` | Get the value of a message property.
`tibemsMsg_GetPropertyNames` | Get a list of property names from a message.
`tibemsMsg_GetRedelivered` | Get the redelivered header from a message.
`tibemsMsg_GetReplyTo` | Get the reply-to header from a message.
`tibemsMsg_GetTimestamp` | Get the timestamp header from a message.
`tibemsMsg_GetType` | Get the type header of a message.
`tibemsMsg_PropertyExists` | Test whether a named property has been set on a message.
`tibemsMsg_SetCorrelationID` | Set the correlation ID header of a message.
`tibemsMsg_SetDeliveryMode` | Set the delivery mode header of a message.
`tibemsMsg_SetDestination` | Set the destination header of a message.
`tibemsMsg_SetEncoding` | Set the character encoding header of a message.
`tibemsMsg_SetExpiration` | Set the expiration header of a message.
`tibemsMsg_SetMessageID` | Set the message ID header of a message.
`tibemsMsg_SetPriority` | Set the priority header of a message.
``tibemsMsg_Set Property`` | Set the value of a message property.
`tibemsMsg_SetRedelivered` | Set the redelivered header of a message.
`tibemsMsg_SetReplyTo` | Set the reply-to header of a message.
`tibemsMsg_SetTimestamp` | Set the timestamp header of a message.
`tibemsMsg_SetType` | Set the type header of a message.

Message Constants
Constant | Description
--- | ---
`TIBEMS_DEFAULT_DELIVERY_MODE` | `TIBEMS_PERSISTENT` When neither the sending call nor the producer supplies a delivery mode, this default applies.
`TIBEMS_DEFAULT_PRIORITY` | `4` When neither the sending call nor the producer supplies a priority, this default applies. See also, Priority.
`TIBEMS_DEFAULT_TIME_TO_LIVE` | `0` When neither the sending call nor the producer supplies a priority, this default applies. The default value, zero, indicates that messages do not expire. See also Expiration.

Copyright © Cloud Software Group, Inc. All rights reserved.