xcall LOKOUT, flags {,wait, lokmsg}

LOKOUT.SBX provides an application-friendly interface to the lock-out feature in which the file %MIAME%/ashell.lok is used to prevent users from logging into to A-Shell. This routine does nothing about users that are already in, but if you first manage to get them out, this will make sure that they stay out.

Tools you may use in your strategy to deal with the existing users include SEND.SBR, FORCE.SBR, KILJOB.SBX and MX_KILL. See Locking Users Out for additional details.

Source, samples and related functions can be found in SOSLIB:[907,32].

Parameters

flags  (Signed Num)  [in/out]

On input:

      0: clear the existing lockout

      1: set a lockout (requires wait and lokmsg parameters)

Returns <0 on error:

     -1 = too few parameters

     -n = basic error n

wait  (Num)  [in]

0: users logging in can wait as long as they want for lock to clear

#: maximum seconds they can wait

lokmsg  (String)  [in]

Message to display to users trying to log into A-Shell. Should be consistent with the wait flag, and possibly mention that they can use Escape to abort the wait. Use an embedded "\n" to indicate line breaks as needed.

History

2006 March, A-Shell 4.9.952:  Routine added to A-Shell