Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 2 Messages : tibemsMapMsg : tibemsMapMsg_Get

tibemsMapMsg_Get
Function
Purpose
Get data values from a map message.
C Declaration
tibems_status tibemsMapMsg_GetBoolean(
    tibemsMapMsg message,
    const char* name,
    tibems_bool* value );
 
tibems_status tibemsMapMsg_GetByte(
    tibemsMapMsg message,
    const char* name,
    tibems_byte* value );
 
tibems_status tibemsMapMsg_GetBytes(
    tibemsMapMsg message,
    const char* name,
    void** bytes,
    tibems_uint* bytesSize );
 
tibems_status tibemsMapMsg_GetChar(
    tibemsMapMsg message,
    const char* name,
    tibems_wchar* value );
 
tibems_status tibemsMapMsg_GetDouble(
    tibemsMapMsg message,
    const char* name,
    tibems_double* value );
 
tibems_status tibemsMapMsg_GetField(
    tibemsMapMsg message,
    const char* name,
    tibemsMsgField* value );
 
tibems_status tibemsMapMsg_GetFloat(
    tibemsMapMsg message,
    const char* name,
    tibems_float* value );
 
tibems_status tibemsMapMsg_GetInt(
    tibemsMapMsg message,
    const char* name,
    tibems_int* value );
 
tibems_status tibemsMapMsg_GetLong(
    tibemsMapMsg message,
    const char* name,
    tibems_long* value );
 
tibems_status tibemsMapMsg_GetMapMsg(
    tibemsMapMsg message,
    const char* name,
    tibemsMapMsg* value );
 
tibems_status tibemsMapMsg_GetShort(
    tibemsMapMsg message,
    const char* name,
    tibems_short* value );
 
tibems_status tibemsMapMsg_GetString(
    tibemsMapMsg message,
    const char* name,
    const char** value );
COBOL Call
CALL "tibemsMapMsg_GetBoolean"
USING BY VALUE message,
BY REFERENCE name,
BY REFERENCE value,
RETURNING tibems-status
END-CALL.
 
CALL "tibemsMapMsg_GetBytes"
USING BY VALUE message,
BY REFERENCE name,
BY REFERENCE bytes,
BY REFERENCE bytesSize,
RETURNING tibems-status
END-CALL.
 
CALL "tibemsMapMsg_GetByte"
USING BY VALUE message,
BY REFERENCE name,
BY REFERENCE value,
RETURNING tibems-status
END-CALL.
 
CALL "tibemsMapMsg_GetChar"
USING BY VALUE message,
BY REFERENCE name,
BY REFERENCE value,
RETURNING tibems-status
END-CALL.
 
CALL "tibemsMapMsg_GetDouble"
USING BY VALUE message,
BY REFERENCE name,
BY REFERENCE value,
RETURNING tibems-status
END-CALL.
 
CALL "tibemsMapMsg_GetField"
USING BY VALUE message,
BY REFERENCE name,
BY REFERENCE value,
RETURNING tibems-status
END-CALL.
 
CALL "tibemsMapMsg_GetFloat"
USING BY VALUE message,
BY REFERENCE name,
BY REFERENCE value,
RETURNING tibems-status
END-CALL.
 
CALL "tibemsMapMsg_GetInt"
USING BY VALUE message,
BY REFERENCE name,
BY REFERENCE value,
RETURNING tibems-status
END-CALL.
 
CALL "tibemsMapMsg_GetLong"
USING BY VALUE message,
BY REFERENCE name,
BY REFERENCE value,
RETURNING tibems-status
END-CALL.
 
CALL "tibemsMapMsg_GetMapMsg"
USING BY VALUE message,
BY REFERENCE name,
BY REFERENCE value,
RETURNING tibems-status
END-CALL.
 
CALL "tibemsMapMsg_GetShort"
USING BY VALUE message,
BY REFERENCE name,
BY REFERENCE value,
RETURNING tibems-status
END-CALL.
 
CALL "tibemsMapMsg_GetString"
USING BY VALUE message,
BY REFERENCE name,
BY REFERENCE value,
RETURNING tibems-status
END-CALL.
 
message and bytes have usage pointer.
value has usage pointer only in tibemsMapMsg_GetMapMsg and tibemsMapMsg_GetString (but not in the other calls documented in this group).
Parameters
 
tibemsMapMsg_GetBytes stores a pointer to the byte sequence in this location.
tibemsMapMsg_GetBytes stores the length of the byte sequence in this location.
Remarks
The JMS specification defines these calls to extract data from the name-value pairs of a map message.
To get array values from a map message, call tibemsMapMsg_GetField, then extract the array value from the field; see tibemsMsgField on page 134.
When the message does not have a field set for the name, these calls return TIBEMS_NOT_FOUND.

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved