tibemsMsg_GetAsBytes


Function

Purpose

Format message data into a byte sequence.

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. 

message and bytes have usage pointer.

Parameter
Description
message
Fill the byte array with the content of this message.
bytes
The function allocates a byte sequence, and stores a pointer to it in this location.
actual_size
The function stores the length of the byte sequence in 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.

See Also

tibemsMsg_CreateFromBytes

tibemsMsg_GetAsBytesCopy

tibemsMsg_GetByteSize


TIBCO Enterprise Message Service™ C and COBOL Reference
System Release 4.3, February 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com