IFLOG (HLI function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Created page with " ==Summary== <dl> <dt>Description</dt> <dd>The IFLOG call (LOGIN) identifies the user to Model 204 if a login is required.</dd> <dt>Thread type</dt> <dd>multiple cursor IFSTRT...")
 
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]].


==Summary==
==Summary==

Revision as of 22:12, 11 July 2016

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

Summary

Description
The IFLOG call (LOGIN) identifies the user to Model 204 if a login is required.
Thread type
multiple cursor IFSTRT, single cursor IFSTRT
IFCALL function number
Not applicable

Syntax

IFLOG(RETCODE,LOGIN)

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. See the following "Notes and tips" section for more information.
LOGIN [I,c,r] The login information is a required parameter that supplies a valid Model 204 user ID and password that permit entry to the system. Specify the login as a character string using the following format:

userid [account]; password;

where:

userid is required and is a character string that identifies the user who is logging into Model 204.

account is an optional character string, from one to ten characters in length, that supplies an account under which the user is logging into Model 204.

password is a character string that allows the specified user to access Model 204, and it is required unless an external security package is being used. See the following "Notes and tips" section for more information.

Usage notes

Use the IFLOG call to provide login information for an IFAM1 HLI application, as necessary. IFLOG is required in an IFAM1 program where the user authorization is to be validated by a security interface.

Note: IFLOG is available for use only in IFAM1 using an IFSTRT thread.

When an external security interface is performing login validation, Rocket Technical Support recommends the following:

  • Do not specify a user ID in the login for User 0.
  • If a user ID is supplied on the LOGIN command, it must match the user ID of the owner of the address space, or this user ID must exist on CCASTAT. Otherwise, the login fails.

When using an external security interface, do not code the password in the host language program unless the user ID exists on CCASTAT. In this case, if a password is encountered, Model 204 interprets IFLOG as an invalid command.

Completion return code (RETCODE)

Model 204 returns either of the following completion codes for IFLOG:

Code Condition
0 Indicates that the login was successful.
100 Indicates that the login failed.

Coding example (COBOL)

The COBOL coding example below specifies the following IFLOG parameter arguments: login account name USERABC, and login password ECP.

WORKING-STORAGE SECTION. 01 ARGS-FOR-CALL. 05 RETCODE PIC 9(5) COMP SYNC. 05 LOGIN PIC X(12) VALUE 'USERABC;ECP;'. . . . PROCEDURE DIVISION. . . . CALL "IFLOG" USING RETCODE, LOGIN. IF RETCODE IS NOT EQUAL TO ZERO, GO TO ERROR-ROUTINE. . . .