Copyright © TIBCO Software Inc. All Rights Reserved

> tibemsStreamMsg_Write
> Function
> Purpose
> Write data to a stream message.
> Single Value
> C Declarations
> tibems_status tibemsStreamMsg_WriteBoolean(
> tibemsStreamMsg message,
> tibems_bool value );
> tibems_status tibemsStreamMsg_WriteByte(
> tibemsStreamMsg message,
> tibems_byte value );
> tibems_status tibemsStreamMsg_WriteChar(
> tibemsStreamMsg message,
> tibems_wchar value );
> tibems_status tibemsStreamMsg_WriteDouble(
> tibemsStreamMsg message,
> tibems_double value );
> tibems_status tibemsStreamMsg_WriteFloat(
> tibemsStreamMsg message,
> tibems_float value );
> tibems_status tibemsStreamMsg_WriteInt(
> tibemsStreamMsg message,
> tibems_int value );
> tibems_status tibemsStreamMsg_WriteLong(
> tibemsStreamMsg message,
> tibems_long value );
> tibems_status tibemsStreamMsg_WriteShort(
> tibemsStreamMsg message,
> tibems_short value );
> tibems_status tibemsStreamMsg_WriteString(
> tibemsStreamMsg message,
> char* value );
> Array
> C Declarations
> tibems_status tibemsStreamMsg_WriteDoubleArray(
> tibemsMsg message,
> const tibems_double* value,
> tibems_int count );
> tibems_status tibemsStreamMsg_WriteFloatArray(
> tibemsMsg message,
> const tibems_float* value,
> tibems_int count );
> tibems_status tibemsStreamMsg_WriteIntArray(
> tibemsMsg message,
> const tibems_int* value,
> tibems_int count );
> tibems_status tibemsStreamMsg_WriteLongArray(
> tibemsMsg message,
> const tibems_long* value,
> tibems_int count );
> tibems_status tibemsStreamMsg_WriteShortArray(
> tibemsMsg message,
> const tibems_short* value,
> tibems_int count );
> Nested Message C Declarations
> tibems_status tibemsStreamMsg_WriteMapMsg(
> tibemsMsg message,
> tibemsMsg value );
> tibems_status tibemsStreamMsg_WriteStreamMsg(
> tibemsMsg message,
> tibemsMsg value );

> | Nested messages are an extension of the JMS specification. Programs that use this feature are non-compliant.

> COBOL Call
> CALL "tibemsStreamMsg_WriteBoolean"
> USING BY VALUE message,
> BY VALUE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteByte"
> USING BY VALUE message,
> BY VALUE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteChar"
> USING BY VALUE message,
> BY VALUE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteDouble"
> USING BY VALUE message,
> BY VALUE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteDoubleArray"
> USING BY VALUE message,
> BY REFERENCE value,
> BY VALUE count,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteFloat"
> USING BY VALUE message,
> BY VALUE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteFloatArray"
> USING BY VALUE message,
> BY REFERENCE value,
> BY VALUE count,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteInt"
> USING BY VALUE message,
> BY VALUE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteIntArray"
> USING BY VALUE message,
> BY REFERENCE value,
> BY VALUE count,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteLong"
> USING BY VALUE message,
> BY VALUE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteLongArray"
> USING BY VALUE message,
> BY REFERENCE value,
> BY VALUE count,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteMapMsg"
> USING BY VALUE message,
> BY VALUE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteShort"
> USING BY VALUE message,
> BY VALUE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteShortArray"
> USING BY VALUE message,
> BY REFERENCE value,
> BY VALUE count,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteStreamMsg"
> USING BY VALUE message,
> BY VALUE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_WriteString"
> USING BY VALUE message,
> BY REFERENCE value,
> RETURNING tibems-status
> END-CALL.

> | message has usage pointer. value has usage pointer only in tibemsStreamMsg_WriteStreamMsg and tibemsStreamMsg_WriteMapMsg (but not in the other calls documented in this group).

> Parameters

> Parameter | Description
> message | Write a datum to this stream message.
> value | Write this datum. Arrays must not be null.
> count | Array functions set array values of this size.

> Remarks
> Each call writes a data value to the stream, and advances the write position so that the next write call appends to the new end of the stream.
> See Also
> tibemsStreamMsg_WriteBytes on page 122

Copyright © TIBCO Software Inc. All Rights Reserved