WebSphere Message Broker, Version 8.0.0.7 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

cniGetEnvironmentMessage

Use this function to get the CciMessage object that corresponds to the environment tree for the message flow.

Syntax

CciMessage ImportExportPrefix * ImportExportSuffix
  cniGetEnvironmentMessage(
    int*         returnCode,
    CciMessage*  message);

Parameters

returnCode
The return code from the function (output).
Possible return codes are:
  • CCI_SUCCESS
  • CCI_EXCEPTION
  • CCI_INV_MESSAGE_OBJECT
message
The address of the message object for which the environment is to be obtained. This message might be an input message that has been received as an argument to the cniEvaluate implementation function, or a message created by the cniCreateMessage utility function.

Return values

If successful, the address of the message object corresponding to the environment tree is returned. Otherwise, a value of zero is returned, and the returnCode parameter indicates the reason for the error.

Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2016Copyright IBM Corporation 1999, 2016.

        
        Last updated:
        
        Last updated: 2016-05-23 14:47:29


Reference topicReference topic | Version 8.0.0.7 | as07610_