Copyright © TIBCO Software Inc. All Rights Reserved

> tibemsStreamMsg_Read
> Function
> Purpose
> Read primitive datatypes from a stream message.
> C Declaration
> tibems_status tibemsStreamMsg_ReadBoolean(
> tibemsStreamMsg message,
> tibems_bool* value );
> tibems_status tibemsStreamMsg_ReadByte(
> tibemsStreamMsg message,
> tibems_byte* value );
> tibems_status tibemsStreamMsg_ReadChar(
> tibemsStreamMsg message,
> tibems_wchar* value );
> tibems_status tibemsStreamMsg_ReadDouble(
> tibemsStreamMsg message,
> tibems_double* value );
> tibems_status tibemsStreamMsg_ReadFloat(
> tibemsStreamMsg message,
> tibems_float* value );
> tibems_status tibemsStreamMsg_ReadInt(
> tibemsStreamMsg message,
> tibems_int* value );
> tibems_status tibemsStreamMsg_ReadLong(
> tibemsStreamMsg message,
> tibems_long* value );
> tibems_status tibemsStreamMsg_ReadShort(
> tibemsStreamMsg message,
> tibems_short* value );
> tibems_status tibemsStreamMsg_ReadString(
> tibemsStreamMsg message,
> char** value );
> COBOL Call
> CALL "tibemsStreamMsg_ReadBoolean"
> USING BY VALUE message,
> BY REFERENCE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_ReadByte"
> USING BY VALUE message,
> BY REFERENCE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_ReadChar"
> USING BY VALUE message,
> BY REFERENCE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_ReadDouble"
> USING BY VALUE message,
> BY REFERENCE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_ReadFloat"
> USING BY VALUE message,
> BY REFERENCE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_ReadInt"
> USING BY VALUE message,
> BY REFERENCE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_ReadLong"
> USING BY VALUE message,
> BY REFERENCE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_ReadShort"
> USING BY VALUE message,
> BY REFERENCE value,
> RETURNING tibems-status
> END-CALL.
> CALL "tibemsStreamMsg_ReadString"
> USING BY VALUE message,
> BY REFERENCE value,
> RETURNING tibems-status
> END-CALL.

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

> Parameters

> Parameter | Description
> message | Read a field struct from this message.
> value | The function stores a pointer to the field struct in this location.

> Remarks
> Each call reads a unit of data from the stream, and advances the read position so that the next read call gets the next datum. (Other read functions are documented on separate pages.)
> See Also
> tibemsStreamMsg_ReadBytes on page 115
> tibemsStreamMsg_ReadField on page 116

Copyright © TIBCO Software Inc. All Rights Reserved