tibemsMsg_GetAsBytes

Function

Purpose

Get a byte sequence representation of the message object.

C Declaration

tibems_status tibemsMsg_GetAsBytes(
    const tibemsMsg message,
    const void** bytes,
    tibems_int* actual_size );

COBOL Call

CALL "tibemsMsg_GetAsBytes"
     USING BY VALUE message,
           BY REFERENCE bytes,
           BY REFERENCE actual-size,
           RETURNING tibems-status
END-CALL.

Note: message and bytes have usage pointer.

Parameters

Parameter	Description
`message`	Fill the byte array with the content of this message.
`bytes`	Allocate a byte sequence, and store a pointer to it in this location.
`actual_size`	Store the length of the byte sequence at this location.

Remarks

This call formats the data of the message as a byte sequence in EMS wire format, which is suitable for archiving in a file.

The function allocates storage for the byte sequence, and associates it with the message; the byte sequence storage persists until your program destroys the message object.

Your program must not modify the byte sequence. To make a modifiable byte sequence, use tibemsMsg_GetAsBytesCopy instead.

The byte sequence includes data from the message header, message properties, and all message fields.

The byte sequence might contain interior null bytes.