IFSETUP (HLI function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 1: Line 1:
The conventions used on this page are described in [[HLI: Function call list#Function call notation conventions|Function call notation conventions]].
The conventions used on this page are described in [[HLI: Function summary#Function call notation conventions|Function call notation conventions]].


==Summary==
==Summary==

Latest revision as of 19:37, 13 July 2016

The conventions used on this page are described in Function call notation conventions.

Summary

Description
The IFSETUP call (SETUP) initiates contact with Model 204 and sets the PARM parameters and the CCAIN control statements for the IFDIAL IFAM1 Host Language Interface job.
Thread type
IFDIAL
IFCALL function number
86

Syntax

IFSETUP|IFSETP(RETCODE,LANG_IND,EXEC,PROLOGUE)

Compile-only form
Not available
Execute-only form
Not available

Specify the parameters in the syntax order shown above.

Parameter Description
RETCODE [O,i,r] The Model 204 return code is a required output parameter. The code is a binary integer value.

If the IFSETUP call is unsuccessful, Model 204 returns an error code of 400 for an invalid language code (LANG_IND).

LANG_IND [I,i,r] The language indicator is a required input parameter, which establishes the calling sequence convention to be used corresponding to the host language. The indicator specifies the format of parameters that are passed in subsequent calls.

Specify one of the following integer values:

1 = PL/1 F-level, and BAL languages
2 = COBOL, FORTRAN, and BAL languages
3 = PL/1 with +Optimizer/Checkout compilers, VS/FORTRAN, and BAL languages

Note: Any convention may be specified for use with the BAL language, and the BAL programmer must adhere to the convention that is specified when coding parameters.

EXEC [I,c,o] The EXEC specification is an optional input parameter that specifies the value of the PARM parameter of the EXEC JCL statement for the IFAM1 job. Specify a character string, up to 100 bytes in length, and separate parameters with a comma (,). If the language indicator (LANG_IND) setting is 2, append a semicolon (;) to the end of the input string. A null string indicates that no PARM values are to be set.

Note: If the LIBUFF and LOBUFF parameters are to be set, include them in the parameter list. Do not specify the following parameters in the PARM list: ALTIODEV, NUSERS, and NSERVS.

PROLOGUE [I,c,o] The prologue specification is an optional input parameter, which is the first logical line of the CCAIN input stream that is used to specify User 0 parameters.

Specify a character string, and separate parameters with a comma (,). If the language indicator (LANG_IND) setting is 2, append a semicolon (;) to the end of the input string. A null string indicates that no Model 204 parameters are to be set.

Note: Do not specify the following parameters in the User 0 line: ALTIODEV, NUSERS, and NSERVS.

Usage notes

Use the IFSETUP call to set the job control statements for a Host Language Interface IFAM1 IFDIAL job. Issue the IFSETUP call before IFDIAL in the IFAM1 job.

Coding example (PL/1 Optimizer)

DCL NERR FIXED BIN(31) INIT(0); DCL LANG_CODE FIXED BIN(31) INIT(3); /* LANG=3 for PL/1 Opt */ DCL EXEC_PARM CHAR(100) INIT('SYSOPT=144,LIBUFF=500;'); DCL CCAIN_PARM CHAR(256) INIT('SPCORE=5000;'); DCL IFSETUP ENTRY(FIXED BIN(31), FIXED BIN(31), CHAR(*), CHAR(*)); . . . CALL IFSETUP (NERR, LANG_CODE, EXEC_PARM, CCAIN_PARM); . . .