cniGetEnvironmentMessage

Gets the CciMessage object corresponding to the Environment 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 might be an input message received as an argument to the cniEvaluate implementation function, or a message created using the cniCreateMessage utility function.

Return values

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