tibemsMsg_SetType

Function

Purpose

Set the type header of a message.

Note: Message type is distinct from message body type—even though they have similar names. Contrast tibemsMsg_GetBodyType.

C Declaration

tibems_status tibemsMsg_SetType(
    tibemsMsg message,
    const char* value );

COBOL Call

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

Parameters

Parameter Description
message Set the type header of this message.
value Set the type to this value.

Remarks

Some JMS providers use a message repository to store message type definitions. Client programs can store a body type that references a definition in the repository. EMS supports this header, but does not use it.

The JMS specification does not define a standard message definition repository, nor does it define a naming policy for message type definitions.

Some providers require message type definitions for each application message. To ensure compatibility with such providers, client programs can set this header, even if the client application does not use it.

To ensure portability, clients can set this header with symbolic values (rather than literals), and configure them to match the provider’s repository.

See Also

tibemsMsg_GetType