tibemsMsg—Properties Set


Function

Purpose

Set the value of a message property.

C Declaration

tibems_status tibemsMsg_SetBooleanProperty( 
    tibemsMsg message, 
    const char* name, 
    tibems_bool value ); 
 
tibems_status tibemsMsg_SetByteProperty( 
    tibemsMsg message, 
    const char* name, 
    tibems_byte value ); 
 
tibems_status tibemsMsg_SetDoubleProperty( 
    tibemsMsg message, 
    const char* name, 
    tibems_double value ); 
 
tibems_status tibemsMsg_SetFloatProperty( 
    tibemsMsg message, 
    const char* name, 
    tibems_float value ); 
 
tibems_status tibemsMsg_SetIntProperty( 
    tibemsMsg message, 
    const char* name, 
    tibems_int value ); 
 
tibems_status tibemsMsg_SetLongProperty( 
    tibemsMsg message, 
    const char* name, 
    tibems_long value ); 
 
tibems_status tibemsMsg_SetShortProperty( 
    tibemsMsg message, 
    const char* name, 
    tibems_short value ); 
 
tibems_status tibemsMsg_SetStringProperty( 
    tibemsMsg message, 
    const char* name, 
    const char* value ); 

COBOL Call

CALL "tibemsMsg_SetBooleanProperty" 
     USING BY VALUE message, 
           BY REFERENCE name, 
           BY VALUE value, 
           RETURNING tibems-status 
END-CALL. 
 
CALL "tibemsMsg_SetByteProperty" 
     USING BY VALUE message, 
           BY REFERENCE name, 
           BY VALUE value, 
           RETURNING tibems-status 
END-CALL. 
 
CALL "tibemsMsg_SetDoubleProperty" 
     USING BY VALUE message, 
           BY REFERENCE name, 
           BY VALUE value, 
           RETURNING tibems-status 
END-CALL. 
 
CALL "tibemsMsg_SetFloatProperty" 
     USING BY VALUE message, 
           BY REFERENCE name, 
           BY VALUE value, 
           RETURNING tibems-status 
END-CALL. 
 
CALL "tibemsMsg_SetIntProperty" 
     USING BY VALUE message, 
           BY REFERENCE name, 
           BY VALUE value, 
           RETURNING tibems-status 
END-CALL. 
 
CALL "tibemsMsg_SetLongProperty" 
     USING BY VALUE message, 
           BY REFERENCE name, 
           BY VALUE value, 
           RETURNING tibems-status 
END-CALL. 
 
CALL "tibemsMsg_SetShortProperty" 
     USING BY VALUE message, 
           BY REFERENCE name, 
           BY VALUE value, 
           RETURNING tibems-status 
END-CALL. 
 
CALL "tibemsMsg_SetStringProperty" 
     USING BY VALUE message, 
           BY REFERENCE name, 
           BY REFERENCE value, 
           RETURNING tibems-status 
END-CALL. 

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

Parameters

Parameter
Description
message
Set a property on this message.

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.

name
Set a property with this name.

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
Set the property to this value.

Remarks

The JMS specification defines eight calls to set properties with different primitive value types.

Status Code
Description
The message is read-only.

See Also

tibemsMsg—Properties Get


TIBCO Enterprise Message Service™ C and COBOL Reference
System Release 4.3, February 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com