> tibemsTextMsg
> Type
> Purpose
> A message containing a text string.
> Related Types
> tibemsMsg on page 21
> Remarks
> Messages with this body type contain a single value, which is a string.

> Function | Description | Page
> tibemsTextMsg_Create | Create a text message. | 123
> tibemsTextMsg_GetText | Get the string data from a text message. | 124
> tibemsTextMsg_SetText | Set the data string of a text message. | 125

> tibemsTextMsg_Create
> Function
> Purpose
> Create a text message.
> C Declaration
> tibems_status tibemsTextMsg_Create(
> tibemsTextMsg* message );
> COBOL Call
> CALL "tibemsTextMsg_Create"
> USING BY REFERENCE message,
> RETURNING tibems-status
> END-CALL.

> | message has usage pointer.

> Parameters

> Parameter | Description
> message | The function stores a pointer to the new message in this location.

> Remarks
> This call creates a new text message.
> When your application creates a message, it also allocates storage for that message. This storage must subsequently be freed by a call to tibemsMsg_Destroy.
> See Also
> tibemsMsg_Create on page 28
> tibemsMsg_Destroy on page 31
> See Also
> tibemsSession_CreateTextMessage on page 304
> tibemsTextMsg_GetText
> Function
> Purpose
> Get the string data from a text message.
> C Declaration
> tibems_status tibemsTextMsg_GetText(
> tibemsTextMsg message,
> const char** text );
> COBOL Call
> CALL "tibemsTextMsg_GetText"
> USING BY VALUE message,
> BY REFERENCE text,
> RETURNING tibems-status
> END-CALL.

> | message and text have usage pointer.

> Parameters

> Parameter | Description
> message | Get the string from this message.
> text | The function stores a pointer to the string (within the message) in this location.

> Remarks
> When the message does not contain any text (because none has been set), this function sets its text parameter to null.
> tibemsTextMsg_SetText
> Function
> Purpose
> Set the data string of a text message.
> C Declaration
> tibems_status tibemsTextMsg_SetText(
> tibemsTextMsg message,
> const char* text );
> COBOL Call
> CALL "tibemsTextMsg_SetText"
> USING BY VALUE message,
> BY REFERENCE text,
> RETURNING tibems-status
> END-CALL.

> | message has usage pointer.

> Parameters

> Parameter | Description
> message | Put the text into this message.
> text | Copy this string into the message body.

Copyright © TIBCO Software Inc. All Rights Reserved.