HLI: Function summary: Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 2,171: Line 2,171:
</tr>
</tr>
</table>
</table>
<p><sup>1</sup> In IFAM1</p>
<p><sup>2</sup> In IFAM2 and IFAM4</p>


[[Category: Host Language Interface]]
[[Category: Host Language Interface]]

Revision as of 20:11, 29 April 2016

Overview

This topic summarizes the calls that are available using the Model 204 Host Language Interface facility. Read this topic if you are using the HLI facility for the first time.

See the HLI function calls table for a complete listing of HLI function calls.

See HLI: Function calls for a detailed description of each call.

This topic does not provide specific descriptions of HLI calls or information about coding an application program using the calls. For sample coding sequences using HLI calls, see HLI: Threads.

IFDIAL thread calls

IFDIAL thread

An IFDIAL thread provides a line-at-a-time terminal type interface between Model 204 and a host language program that is running in batch.

With an IFDIAL thread, an application that is written in a host language can transmit data to and from Model 204 using the IFWRITE and IFREAD calls.

See HLI: Job requirements for information about setting up and running the batch Model 204 job using an IFDIAL thread.

Summary of IFDIAL calls

The following table summarizes the HLI calls that are available for use only with an IFDIAL thread. See HLI: Function calls for a detailed description of each call.

IFDIAL functions

Call Function
IFATTN Sends an attention interrupt.
IFDIAL Starts an IFDIAL thread.
IFDIALN Starts an IFDIAL thread using a specified communications channel name.
IFHNGUP Ends all threads that are started in a job.
IFREAD Gets a line of output from Model 204.
IFSETUP Initiates contact with Model 204 and sets the PARM parameters and CCAIN statements for the IFAM1 job.
IFWRITE Sends a line of input to Model 204.

IFSTRT thread calls

IFSTRT thread

An IFSTRT thread provides a user interface between Model 204 and a host language program that is running in batch.

With an IFSTRT thread, an application that is written in a host language can issue calls to Model 204 that perform operations against the database which are similar to Model 204 commands and SOUL statements.

See HLI: Job requirements for information about setting up and running the Online or batch Model 204 job using an IFSTRT thread. See HLI: Function calls for a detailed description of the IFSTRT call.

Different operational levels

The HLI calls that are available for use with an IFSTRT thread are categorized by functionality and operate at the following levels:

  • System
  • Transaction
  • File or group
  • Set
  • Single record

A typical application program works at all levels, using the HLI calls that are available at each level. The calls that are available in each of these categories are summarized in the tables on the following pages.

Enqueuing action and record locking behavior

When several users have access to the same files or groups, Model 204 prevents conflicting, simultaneous use of records with a facility called enqueuing. Enqueuing is performed at the thread level.

With an IFSTRT thread, most HLI function calls automatically enqueue and dequeue on the resources, such as the files, groups, sets, or records, to which they refer.

See HLI: Function calls for detailed information about the record locking behavior of individual calls. See HLI: Locking behavior of HLI calls for more information about enqueueing on an IFSTRT thread.

System level IFSTRT calls

System level functions constitute the highest level of access to the Host Language Interface Model 204 service routines. At the system level, most functions do not require a file or group context.

The following table summarizes the IFSTRT calls that function at the system level.

System level IFSTRT calls

Call Function
IFCALL Calls another HLI function by number.
IFCHKPT Requests a checkpoint, checkpoint status information, or both. (Note that IFCHKPT is also a transaction-level function.)
IFDTHRD Deletes the current thread and switches to another thread.
IFEFCC Returns specific information about field values or record numbers that cause a field constraint conflict using the IFSTOR, IFUPDT, or IFPUT HLI calls
IFEPRM Reads a parameter.
IFERLC Returns a file name, record number, and user name after a record locking conflict occurs in an HLI program that issues a call that requires locking a record
IFERR Places a message on the journal, requests a snap dump of the Model 204 region, or both.
IFFNSH Deallocates all threads; finishes HLI portion of program.
IFGERR Reads the latest error message produced by Model 204.
IFLOG Logs in user with user ID and password (IFAM1).
IFRPRM Resets a parameter.
IIFSPRM Sets a parameter.
IFSTHRD Switches from one thread to another.
IIFSTRT Establishes an IFSTRT thread connection.
IFSTRTN Establishes an IFSTRT thread connection to an alternate HLI Model 204 service program.
IFUTBL Resets the size of a user's server tables.

Transaction level IFSTRT calls

Transaction level functions operate in a job that uses the Host Language Interface facility to manage transactions for a logical unit of work processing against the Model 204 database.

The following table summarizes the IFSTRT calls that function at the transaction level.

Transaction level IFSTRT calls

Call Function
IFBOUT Backs out current transaction.
IFCHKPT Requests a checkpoint or checkpoint status or both.

Note: IFCHKPT is also a system-level function.

IFCMMT Commits the current transaction.
IFCMTR Releases all record sets and commits the current transaction.
IFRELA Releases all record sets.

File or group level IFSTRT calls

HLI functions at the file or group level operate with a file or group.

For example, whenever an application program requires access to a Model 204 file, a file or group must be opened. IFOPEN must be called before any other file or group level functions. IFOPEN establishes the current file or group on which subsequent file or group level, record level, and set level functions operate.

Note: On a single cursor IFSTRT thread, each thread can have only one current file or group. All functions operate against this file or group.

On a multiple cursor IFSTRT thread, multiple files or groups can be accessed, and the file or group that is specified in the HLI call is the one that is current for processing. If the file specification is optional and no file is specified, the file that was opened last is current, by default.

The following table summarizes the IFSTRT calls that function at the file or group level.

File or group level IFSTRT calls

Call Function
IFCLOSE Closes all files and groups for the current thread.
IFDELF Deletes a field definition in a file. IFDELF can be used only if the current context is a file.
IFDFLD Defines new fields in a file.
IFDISP Displays file, group, and other information.
IFFLS Checks for field-level security violations.
IFINIT Initializes a file. IFINIT can be used only if the current context is a file.
IFNFLD Renames fields in a file. IFNFLD can be used only if the current contest is a file.
IFOPEN Opens a file or group.
IFOPENX Opens a file or group, enqueuing upon the file(s) in exclusive status.
IFRFLD Redefines fields in a file. IFRFLD can be used only if the current context is a file.

Record set level IFSTRT calls

Functions at the record set level operate with sets of records or field values.

For example, the IFFIND function must be called to establish a current set before any other set level functions can operate successfully.

On a multiple cursor IFSTRT thread, the set that is specified in the HLI call is the one that is current for processing. On a single cursor IFSTRT thread, the current set is the one last created.

The IFSTRT calls that function at the record set level are summarized in the following tables:

Record set level calls on any IFSTRT thread

The following table lists calls that can be used on both multiple cursor and single cursor IFSTRT threads.

Record set level calls on any IFSTRT thread

Call Function
IFCOUNT Counts the number of records in the current set.
IFDSET Deletes the current set of records from the file or group.
IFFAC Finds and returns record count.
IFFACC Compiles an IFFAC specification.
IFFACE Executes a precompiled IFFAC specification.
IFFDV Selects a set of field values to become the current value set.
IFFDVC Compiles an IFFDV specification.
IFFDVE Executes a precompiled IFFDV specification.
IFFILE Adds an invisible key field to all records in the current set.
IFFIND Selects a set of records as the current set.
IFFINDC Compiles an IFFIND specification.
IFFINDE Executes a precompiled IFFIND specification.
IFFNDX Selects a set of records and enqueues upon them exclusively.
IFFNDXC Compiles an IFFNDX specification.
IFFNDXE Executes a precompiled IFFNDX specification.
IFFWOL Selects a set of records as the current set, without locking.
IFFWOLC Compiles an IFFWOL specification.
IFFWOLE Executes a precompiled IFFWOL specification.
IFSKEY Sorts the records in the current IFFIND set; only the record key is written to the sort records.
IFSKYC Compiles the IFSKEY specification.
IFSKYE Executes the precompiled IFSKEY specification.
IFSORT Sorts the records in the current set.
IFSRTC Compiles the IFSORT sort specification.
IFSRTE Executes the precompiled IFSORT or IFSRTC specification.
IFSRTV Sorts the values in the current value set.
IFSTVC Compiles the IFSRTV specification.
IFSTVE Executes the precompiled IFSRTV specification.

Record set level calls on a multiple cursor IFSTRT thread

The following table lists those calls that can be used only on a multiple cursor IFSTRT thread.

Record set level calls on a multiple cursor IFSTRT thread

Call Function
IFCCUR Closes a cursor on a set.
IFCLST Clears a list.
IFOCUR Opens a cursor on a set.
IFOCURC Compiles the IFOCUR specification.
IFOCURE Executes the precompiled IFOCUR specification.
IFPROLS Places records from a found set onto a list.
IFRELR Releases records in a found set.
IFRRFLS Removes records in a found set from a list.

Record set level calls on a single cursor IFSTRT thread

The following table lists those calls that can be used only on a single cursor IFSTRT thread.

Record set level calls on a single cursor IFSTRT thread

Call Function
IFDEQL Dequeues the set of records on a specified list.
IFENQL Enqueues in share or exclusive mode on the set of records of the specified list.
IFLIST Places the records in the current set onto a named list.

Individual record level IFSTRT calls

Individual record functions operate on a record.

On a single cursor IFSTRT thread, IFGET, IFBREC, and IFPOINT establish the current record on which they and other functions at this level operate.

On a multiple cursor IFSTRT thread, the current record in the cursor that is specified in the HLI call is the record that is current for processing. The current record in a cursor is established by an IFFTCH, IFSTOR, or IFFRN call.

The IFSTRT calls that function at the single record level are summarized in the following tables:

Individual record level calls on any IFSTRT thread

Call Function
IFDALL Deletes all the occurrences of a field from the current record.
IFDREC Deletes the current record from its file.
IFDVAL Deletes a field name = value pair.
IFPROL Places the current record on a named list.
IFRRFL Removes the current record from a named list.

Individual record level calls on a multiple cursor IFSTRT thread

The following table lists those calls that can be used only on a multiple cursor IFSTRT thread.

Individual record level calls on a Multiple Cursor IFSTRT thread

Call Function
IFFRN Points to the specified record in the specified file and makes it the current record.
IFFRNC Compiles the IFFRN specification.
IFFRNE Executes the precompiled IFFRN specification.
IFFTCH Processes the next logical record or value and returns the specified data.
IFFTCHC Compiles the IFFTCH specification.
IFFTCHE Executes the precompiled IFFTCH specification.
IFOCC Counts the number of occurrences of the specified field in the current record and returns a count.
IFOCCC Compiles the IFOCC specification.
IFOCCE Executes the precompiled IFOCC specification.
IFRNUM Returns the number of the current record in the specified cursor.
IFSTOR Creates a new record with the specified data and adds the record to the specified file.
IFSTRC Compiles the IFSTOR specification.
IFSTRE Executes the precompiled IFSTOR specification.
IFUPDT Updates the current record with the specified data.
IFUPDTC Compiles the IFUPDT specification.
IFUPDTE Executes the precompiled IFUPDT specification.

Individual record level calls on a single cursor IFSTRT thread

The following table lists those calls that can be used only on a single cursor IFSTRT thread.

Individual record level calls on a single cursor IFSTRT thread

Call Function
IFBREC Creates a new record.
IFCTO Counts the number of field occurrences in the current record.
IFCTOC Compiles an IFCTO specification.
IFCTOE Executes a precompiled IFCTO specification.
IFGET Reads information from the next record in the current set.
IFGETC Compiles an IFGET specification.
IFGETE Executes a precompiled IFGET specification.
IFGETV Reads the next value from the current value set.
IFGETX Reads information from the next record, enqueuing upon it exclusively.
IFGETXE Executes a precompiled IFGET specification, enqueuing upon the record exclusively.
IFGTVC Compiles the IFGETV specification.
IFGTVE Executes the precompiled IFGETV.
IFMORE Reads more information from the current record.
IFMOREC Compiles an IFMORE specification.
IFMOREE Executes a precompiled IFMORE specification.
IFMOREX Reads more information from the current record, enqueuing upon the record exclusively.
IFMORXE Executes a precompiled IFMORE specification, enqueuing upon the record exclusively.
IFPOINT Specifies a new current record.
IFPUT Updates the current record.
IFPUTC Compiles an IFPUT record.
IFPUTE Executes a precompiled IFPUT specification.

IFSTRT thread calls and compiled IFAM

Compiled IFAM facility

The Compiled IFAM (Inverted File Access Method) facility allows IFSTRT thread calls to be compiled and stored.

Using the Compiled IFAM facility, you can execute a compilation at a later time by specifying the name under which it was stored. You do not need to recompile the stored call.

A compilation must be uniquely identified so that multiple calls can use it. The name parameter included in all Compiled IFAM calls specifies a character string that is used to identify the compilation. A null name string is the same as an omitted parameter.

Three forms of Compiled IFAM calls

Three forms of IFSTRT calls are available using the Compiled IFAM facility: compile and execute, compile-only, and execute-only. The following options are available to accommodate different programming styles:

  • Using a single call that compiles and executes with the name parameter that identifies the compilation. The call executes and the compiled version of the call is saved.

    When the same call is executed again or when another call containing the same name parameter is executed, the stored compilation is executed without requiring recompilation.

  • Using two calls, one is compile-only and one is execute-only, with the name parameter that identifies the compilation for the two phases of Compiled IFAM processing: compilation and execution.

    This option involves a two-call procedure, useful in loop processing. The compilation form of the call is used outside the loop to compile (but not execute) the call specification. Within the loop, the execution form of the call is issued, thereby executing the previously compiled call.

See the HLI function calls table for an overview of the calls that provide Compiled IFAM functionality for IFSTRT thread processing.

See HLI: IFSTRT processing for more information about IFSTRT calls and the Compiled IFAM facility.

Complete listing of HLI function calls

The following table provides a summary overview of the calls that are available using the HLI facility, including their Compiled IFAM and multiple cursor (MC) functionality.

For each call, this table provides the following information:

  • Name: Names are listed in alphabetical order. Names that are underlined indicate an IFDIAL thread call; all others are IFSTRT thread calls.
  • # lists the number that can be used to reference the function using IFCALL.
    Note that IFCALL, IFLOG, and IFSTRT (in IFAM1) do not have numbers.
  • Alias: An asterisk indicates that the name is an alias, that is, the shortened COBOL form (six characters or less in length) for the equivalent call (under Equivalent). A dash indicates that the call name is not an alias.
  • Compiled IFAM indicates whether the call performs compile and execute, compile only, or execute only processing.
  • Related call(s) lists functionally similar calls which provide alternate Compiled IFAM processing. For example, for IFCTO (which compiles and executes), related calls are: IFCTOC (compiles only) and IFCTOE (executes only).
  • MC: An asterisk indicates that the call is valid for use with a multiple cursor IFSTRT thread.

HLI function calls

Name # Alias Equivalent Compiled IFAM Related call(s) MC
IFABXIT 97 - - - - *
IFATTN 43 - - - - -
IFBOUT 71 - - - - *
IFBREC 20 - - - - -
IFCALL - - - - - *
IFCCUR 125 - - - - *
IFCHKP 30 * IFCHKPT - - *
IFCHKPT 30 - IFCHKP - - *
IFCLOS 12 * IFCLOSE - - *
IFCLOSE 12 - IFCLOS - - *
IFCLST 108 - - - - *
IFCMMT 72 - - - - *
IFCMTR 105 - - - - *
IFCNT 14 * IFCOUNT - - *
IFCOUNT 14 - IFCNT - - *
IFCSA 96 - - - - *
IFCTO 65 - - Compile and execute IFCTOC, IFCTOE -
IFCTOC 66 - - Compile only IFCTO, IFCTOE -
IFCTOE 67 - - Execute only IFCTO, IFCTOC -
IFDALL 73 - - - - *
IFDECL   - - - - -
IFDELF 62 - - - - *
IFDEQ 38 - - - - *
IFDEQL 41 - - - - -
IFDFLD 24 - - - - *
IFDIAL 6 - - - - -
IFDIALN 7 - IFDILN - - -
IFDILN 7 * IFDIALN - - -
IFDISP 60 - - - - *
IFDREC 19 - - - - *
IFDSET 21 - - - - *
IFDTHRD 42 - IFDTRD - - *
IFDTRD 42 * IFDTHRD - - *
IFDVAL 32 - - - - *
IFEFCC 139 - - - - *
IFENQ 39 - - - - *
IFENQL 40 - - - - -
IFEPRM 25 - - - - *
IFERLC 138 - - - - *
IFERR 28 - - - - *
IFFAC 126 - - Compile and execute IFFACC, IFFACE *
IFFACC 127 - - Compile only IFFAC, IFFACE *
IFFACE 128 - - Execute only IFFAC, IFFACC *
IFFCHC 99 * IFFTCHC Compile only IFFTCH, IFFCHE *
IFFCHE 100 * IFFTCHE Execute only IFFTCH, IFFCHC *
IFFD 13 * IFFIND Compile and execute IFFDC, IFFDE *
IFFDC 46 * IFFINDC Compile only IFFD, IFFDE *
IFFDE 47 * IFFINDE Execute only IFFD, IFFDC *
IFFDV 74 - - Compile and execute IFFDVC, IFFDVE *
IFFDVC 75 - - Compile only IFFDV, IFFDVE *
IFFDVE 76 - - Execute only IFFDV, IFFDVC *
IFFDX 56 * IFFNDX Compile and execute IFFDXC, IFFDXE *
IFFDXC 57 * IFFNDXC Compile only IFFDX, IFFDXE *
IFFDXE 58 * IFFNDXE Execute only IFFDX, IFFDXC *
IFFILE 22 - - - - *
IFFIND 13 - IFFD Compile and execute IFFINDC, IFFINDE *
IFFINDC 46 - IFFDC Compile only IFFIND, IFFINDE *
IFFINDE 47 - IFFDE Execute only IFFIND, IFFINDC *
IFFLS 61 - - - - *
IFFLSH 45 * IFFLUSH - - *
IFFLUSH 45 - IFFLSH - - *
IFFNDX 56 - IFFDX Compile and execute IFFNDXC, IFFNDXE *
IFFNDXC 57 - IFFDXC Compile only IFFNDX, IFFNDXE *
IFFNDXE 58 - IFFDXE Execute only IFFNDX, IFFNDXC *
IFFNSH 3 - - - - *
IFFRN 118 - - Compile and execute IFFRNC, IFFRNE *
IFFRNC 119 - - Compile only IFFRN, IFFRNE *
IFFRNE 120 - - Execute only IFFRN, IFFRNC *
IFFTCH 98 - - Compile and execute IFFTCHC, IFFTCHE *
IFFTCHC 99 - IFFCHC Compile only IFFTCH, IFFTCHE *
IFFTCHE 100 - IFFCHE Execute only IFFTCH, IFFTCHC *
IFFWO 87 * IFFWOL Compile and execute IFFWOC, IFFWOE *
IFFWOC 88 * IFFWOLC Compile only IFFWO, IFFWOE *
IFFWOE 89 * IFFWOLE Execute only IFFWO, IFFWOC *
IFFWOL 87 - IFFWO Compile and execute IFFWOLC, IFFWOLE *
IFFWOLC 88 - IFFWOC Compile only IFFWOL, IFFWOLE *
IFFWOLE 89 - IFFWOE Execute only IFFWOL, IFFWOLC *
IFGERR 29 - - - - *
IFGET 15 - - Compile and execute IFGETC, IFGETE -
IFGETC 48 - - Compile only IFGET, IFGETE -
IFGETE 49 - - Execute only IFGET, IFGETC -
IFGETV 77 - - Compile and execute IFGTVC, IFGTVE -
IFGETX 36 - - Compile and execute IFGETXE, IFGETC -
IFGETXE 50 - IFGTXE Execute only IFGETX -
IFGTVC 78 - - Compile only IFGETV, IFGTVE -
IFGTVE 79 - - Execute only IFGETV, IFGTVC -
IFGTXE 50 * IFGETXE Execute only IFGETX -
IFHNGP 8 * IFHNGUP - - -
IFHNGUP 8 - IFHNGP - - -
IFINIT 23 - - - - *
IFLIST 17 - - - - -
IFLOG - - - - - *
IFMORE 16 - - Compile and execute IFMREC, IFMREE, IFMOREC, IFMOREE -
IFMOREC 51 - IFMREC Compile only IFMORE, IFMOREE -
IFMOREE 52 - IFMREE Execute only IFMORE, IFMOREC -
IFMOREX 37 - IFMREX Compile and execute IFMORXE, IFMOREC -
IFMORXE 53 - IFMRXE Execute only IFMOREX -
IFMREC 51 * IFMOREC Compile only IFMORE, IFMREE -
IFMREE 52 * IFMOREE Execute only IFMORE, IFMREC -
IFMREX 37 * IFMOREX Compile and execute IFMRXE -
IFMRXE 53 * IFMORXE Execute only IFMREX -
IFNFLD 63 - - - - *
IFOCC 122 - - Compile and execute IFOCCC, IFOCCE *
IFOCCC 123 - - Compile only IFOCC, IFOCCE *
IFOCCE 124 - - Execute only IFOCC, IFOCCC *
IFOCRC 106 * IFOCURC Compile only IFOCUR, IFOCRE *
IFOCRE 107 * IFOCURE Execute only IFOCUR, IFOCRC *
IFOCUR 95 - - Compile and execute IFOCRC, IFOCRE, IFOCURC, IFOCURE *
IFOCURC 106 - IFOCRC Compile only IFOCUR, IFOCURE *
IFOCURE 107 - IFOCRE Execute only IFOCUR, IFOCURC *
IFOPEN 11 - - - - *
IFOPENX 35 - IFOPNX - - *
IFOPNX 35 * IFOPENX - - *
IFPNT 44 * IFPOINT - - -
IFPOINT 44 - IFPNT - - -
IFPRLS 109 * IFPROLS - - *
IFPROL 33 - - - - *
IFPROLS 109 - IFPRLS - - *
IFPUT 18 - - Compile and execute IFPUTC, IFPUTE -
IFPUTC 54 - - Compile only IFPUT, IFPUTE -
IFPUTE 55 - - Execute only IFPUT, IFPUTC -
IFREAD 9 - - - - -
IFRELA 104 - - - - *
IFRELR 103 - - - - *
IFRFLD 59 - - - - *
IFRFLS 110 * IFRRFLS - - *
IFRNUM 121 - - - - *
IFRPRM 27 - - - - *
IFRRFL 34 - - - - *
IFRRFLS 110 - IFRFLS - - *
IFSETP 86 * IFSETUP - - -
IFSETUP 86 - IFSETP - - -
IFSKEY 83 - - Compile and execute IFSKYC, IFSKYE *
IFSKYC 84 - - Compile only IFSKEY, IFSKYE *
IFSKYE 85 - - Execute only IFSKEY, IFSKYC *
IFSORT 68 - - Compile and execute IFSRTC, IFSRTE *
IFSPRM 26 - - - - *
IFSRTC 69 - - Compile only IFSORT, IFSRTE *
IFSRTE 70 - - Execute only IFSORT, IFSRTC *
IFSRTV 80 - - Compile and execute IFSTVC, IFSTVE *
IFSTHRD 2 - IFSTRD - - *
IFSTOR 112 - - Compile and execute IFSTRC, IFSTRE *
IFSTRC 113 - - Compile only IFSTOR, IFSTRE *
IFSTRD 2 * IFSTHRD - - *
IFSTRE 114 - - Execute only IFSTOR, IFSTRC *
IFSTRN 4 * IFSTRTN - - *
IFSTRT (IFAM1) - - - - - *
IFSTRT (IFAM2/IFAM4) 1 - - - - *
IFSTRTN (IFAM2) 4 - IFSTRN - - *
IFSTVC 81 - - Compile only IFSRTV, IFSTVE *
IFSTVE 82 - - Execute only IFSRTV, IFSTVC *
IFUPDC 116 * IFUPDTC Compile only IFUPDT, IFUPDE *
IFUPDE 117 * IFUPDTE Execute only IFUPDT, IFUPDC *
IFUPDT 115 - - Compile and execute IFUPDC, IFUPDE, IFUPDTC, IFUPDTE *
IFUPDTC 116 - IFUPDC Compile only IFUPDT, IFUPDTE *
IFUPDTE 117 - IFUPDE Execute only IFUPDT, IFUPDTC *
IFUTBL 64 - - - - *
IFWRIT 10 * IFWRITE - - -
IFWRITE 10 - IFWRIT - - -