Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 14 Introduction to the Call Level Interface : HRNHLLTM Module Parameters

HRNHLLTM Module Parameters
Valid Call Parameters
The following table provides a description of each parameter to HRNHLLTM and tells whether each parameter is of type IN, OUT, or IN/OUT.
Work area of 687-bytes, used by the Call Level Interface to maintain the handles to the Execution Environment, session, stream and transaction and cursor context. This work area is in the same format as that used by the Host Languages Interface.
Uppercase character string naming the type of interface call to be performed. For example, the string STARTEE designates the Start Execution Environment operation; and STOPEE, the Stop Execution Environment operation.
Refer to Operational Parameters for a listing of call OPERATION parameters.
Uppercase character string used as an operand of the OPERATION to further qualify the operation. For example, the string BATCH qualifies the STARTEE operation.
Variable length uppercase character string used as a parameter to the OPERATION/OPERAND. For example, the assembler string:
can be used as a PARM to the STARTEE BATCH function to specify that the Execution Environment is to connect to a Data Object Broker called DEV3.
The variable-length string is made up of a two-byte header containing the length of the string and the string that must immediately follow the header. An empty string of length zero is represented by two-byte header with a value of binary 0. Rules arguments enclosed in quotes can contain lowercase data.
This parameter is used only when calling a rule. In this case, DATA-IN is used to pass blocks of data from the client to the session. Refer to Calling a Rule – CALLRULE for a detailed description of this parameter.
This parameter is used only when calling a rule. In this case DATA-OUT is used to pass data from the session to the client. Refer to Calling a Rule – CALLRULE for a detailed description of this parameter.
For some interface functions, if the RETURN-CODE is 0, this parameter contains feedback data.
If the RETURN-CODE is non-zero, the parameter contains either a reason-code or a variable length message. RETURN-DATA should be at least 159 bytes long to accommodate the largest possible return message.
Four-byte return code returned by the interface indicating the success of the requested operation. A value of 0 indicates success; any other value indicates that the operation did not complete successfully, with the exception of the STARTEE and STOPEE calls. If the return code is non-zero, the RETURN-DATA parameter can contain a reason code or a message.
Refer to Starting or Locating the Execution Environment – STARTEE and Stopping the Execution Environment – STOPEE for further explanation of return codes in the STARTEE and STOPEE calls.
Operational Parameters
The following table relates each Call Level Interface function to an OPERATION and OPERAND parameter value. Ignored parameters are blank in the table.
Interface Function
Start or locate an Execution Environment
Execution Environment parameters
Session parameters
Start a transaction /stream and set its characteristics
{BROWSE|UPDATE}
{TEST|
NOTEST}
LIBRARY= xxxxxxxx
Rule and its arguments
End transaction/ stream
Stop an Execution Environment

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved