tibemsMsg_Get Property

Function

Purpose

Get the value of a message property.

C Declaration

tibems_status tibemsMsg_Get Property(
    tibemsMsg message, 
    const char* name,
    tibemsMsgField* value );

 tibems_status tibemsMsg_GetBooleanProperty(
     tibemsMsg message, 
     const char* name,
     tibems_bool* value );

 tibems_status tibemsMsg_GetByteProperty(
     tibemsMsg message, 
     const char* name,
     tibems_byte* value );

 tibems_status tibemsMsg_GetDoubleProperty(
     tibemsMsg message, 
     const char* name,
     tibems_double* value );

 tibems_status tibemsMsg_GetFloatProperty(
     tibemsMsg message, 
     const char* name,
     tibems_float* value );

 tibems_status tibemsMsg_GetIntProperty(
     tibemsMsg message, 
     const char* name,
     tibems_int* value );

 tibems_status tibemsMsg_GetLongProperty(
     tibemsMsg message, 
     const char* name,
     tibems_long* value );

 tibems_status tibemsMsg_GetShortProperty(
     tibemsMsg message, 
     const char* name,
     tibems_short* value );

tibems_status tibemsMsg_GetStringProperty(
    tibemsMsg message, 
    const char* name,
    char** value );

COBOL Call

CALL "tibemsMsg_Get Property"
     USING BY VALUE message,
           BY REFERENCE name,
           BY REFERENCE value,
           RETURNING tibems-status
END-CALL.

CALL "tibemsMsg_GetBooleanProperty"
     USING BY VALUE message,
           BY REFERENCE name,
           BY REFERENCE value,
           RETURNING tibems-status
END-CALL.

CALL "tibemsMsg_GetByteProperty"
     USING BY VALUE message,
           BY REFERENCE name,
           BY REFERENCE value,
           RETURNING tibems-status
END-CALL.

CALL "tibemsMsg_GetDoubleProperty"
     USING BY VALUE message,
           BY REFERENCE name,
           BY REFERENCE value,
           RETURNING tibems-status
END-CALL.
CALL "tibemsMsg_GetFloatProperty"
     USING BY VALUE message,
           BY REFERENCE name,
           BY REFERENCE value,
           RETURNING tibems-status
END-CALL.

CALL "tibemsMsg_GetIntProperty"
     USING BY VALUE message,
           BY REFERENCE name,
           BY REFERENCE value,
           RETURNING tibems-status
END-CALL.

CALL "tibemsMsg_GetLongProperty"
     USING BY VALUE message,
           BY REFERENCE name,
           BY REFERENCE value,
           RETURNING tibems-status
END-CALL.

CALL "tibemsMsg_GetShortProperty"
     USING BY VALUE message,
           BY REFERENCE name,
           BY REFERENCE value,
           RETURNING tibems-status
END-CALL.

CALL "tibemsMsg_GetStringProperty"
     USING BY VALUE message,
           BY REFERENCE name,
           BY REFERENCE value,
           RETURNING tibems-status
END-CALL.
Note: message has usage pointer.

value has usage pointer only in tibemsMsg_GetStringProperty (but not in the other calls documented in this group).

Parameters

Parameter Description
message Get a property from this message.
name Get the property with this name (case sensitive).

Property names must obey the JMS rules for a message selector identifier (see Message Selectors). Property names must not be null, and must not be empty strings.

value Store the value.

Remarks

The JMS specification defines eight calls to get properties with different value types—converting between compatible types. All of these functions convert property values to the corresponding type (if possible).

Status Code Description
TIBEMS_CONVERSION_FAILED The actual type of the property is not compatible with the requested type.
TIBEMS_NOT_FOUND The property is not set in this message.

See Also

tibemsMsg_Set Property