cniCreateInputTerminal

Use this function to create an input terminal on an instance of a node object and return the address of the terminal object that was created.

The terminal object is destroyed by the integration node when its owning node is destroyed. You must call this function only from within the implementation function cniCreateNodeContext.

Syntax

CciTerminal* cniCreateInputTerminal(
  int*      returnCode,
  CciNode*  nodeObject,
  CciChar*  name);

Parameters

returnCode

The return code from the function (output).

Possible return codes are:

CCI_SUCCESS
CCI_EXCEPTION
CCI_INV_NODE_OBJECT
CCI_INV_TERMINAL_NAME

nodeObject

Specifies the address of the instance of the node object on which the input terminal is to be created (input). The handle is passed to the cniCreateNodeContext function.

name

Specifies a name for the terminal being created (input).

Return values

If successful, the address of the node terminal object is returned. Otherwise, a value of zero (CCI_NULL_ADDR) is returned.

Example

   entry->handle = cniCreateInputTerminal(
                                          &rc, 
                                          context->nodeObject, 
                                          (CciChar*)terminalName);