tibemsConnection_SetClientId


Function

Purpose

Set the client ID of a connection.

C Declaration

tibems_status tibemsConnection_SetClientId( 
    tibemsConnection connection, 
    const char* clientId ); 

COBOL Call

CALL "tibemsConnection_SetClientId" 
     USING BY VALUE connection, 
           BY REFERENCE clientId, 
           RETURNING tibems-status 
END-CALL. 

connection has usage pointer.

Parameter
Description
connection
Set the client ID of this connection.
clientId
Set the client ID to this string.

Remarks

Each connection uses a unique client ID.
Client IDs partition the namespace of durable subscribers; see tibemsSession_CreateDurableSubscriber .
Administrators can configure connection factories to assign client IDs to new connections. Alternatively, administrators can allow client programs to assign their own IDs. If the factory does not assign an ID, the program may set this property. However, it is illegal to overwrite an existing client ID value, and or to set this property after using the connection in any way (for example, after creating a session, or starting the connection); attempting to set this property in these situations results in TIBEMS_ILLEGAL_STATE.

See Also

tibemsConnection_GetClientId


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