WebSphere Message Brokers
File: as36920_
Writer: Kate Hostler

Reference topic

This build: July 31, 2007 21:39:00

cciGetSourceTerminalName

This function returns the name of the output terminal of the source node for the specified connection.

Syntax

CciSize  cciGetSourceTerminalName (int*           returnCode,
                                   CciConnection* connection,
                                   CciChar*       value,
                                   CciSize        length);

Parameters

returnCode (output)
Receives the return code from the function (output).
  • CCI_BUFFER_TOO_SMALL

    The provided buffer was not large enough to hold the value of node’s name.

connection (input)
This is a handle to a connection between two nodes.
value (output)
Address of a buffer, allocated by the caller to hold the value of the terminal’s name.
length
The length, in CciChars, of the buffer allocated by the caller.

Return values

  • If successful, the terminal name is copied into the supplied buffer and the number of CciChar characters copied is returned.
  • If the buffer is not large enough to contain the attribute value, returnCode is set to CCI_BUFFER_TOO_SMALL, and the number of CciChars required is returned.

Example

void myPropagatedMessageCallback(
                        CciDataContext* userContext,
                        CciMessage*     message,
                        CciMessage*     localEnvironment,
                        CciMessage*     exceptionList,
                        CciMessage*     environment,
                        CciConnection*  connection){
	 int rc = CCI_SUCCESS;
   CciChar sourceTerminalName[initialStringBufferLength];
   cciGetSourceTerminalName(&rc,
                            connection,
                            sourceTerminalName,
                            initialStringBufferLength);
}
Related concepts
User exits
Related tasks
Developing a user exit
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2007Copyright IBM Corporation 1999, 2007. All Rights Reserved.
This build: July 31, 2007 21:39:00

as36920_ This topic's URL is: