|
|
NM and CM callable.
Provides access to the user logging facility.
Syntax
I32 CA CA I16 I16
OPENLOG (index, logid, pass, mode, logstatus);
Parameters
- index
32-bit signed integer by reference (required)
Returns the user logging access. The User Logging facility uses the value
of the index parameter to check the validity of
subsequent calls to the other user logging intrinsics. The value returned
is valid only for the process that made the OPENLOG
call.
- logid
character array (required)
Passes the user logging identifier. Contains up to eight alphanumeric
characters. Arrays < 8-characters must be terminated with a
nonalphanumeric character.
- pass
character array (required)
Passes the password associated with the user logging identifier by the
GETLOG command.
- mode
16-bit signed integer by reference (required)
Passes a value indicating whether the user logging facility suspends the
process if it cannot complete the request for service immediately:
- Value
Meaning
- 0
Wait
- 1
Nowait
If it is not possible to log the transaction and mode is
set to nowait, logstatus indicates that it could not
complete the request.
- logstatus
16-bit signed integer by reference (required)
Returns one of the following values, indicating the success/failure of
the call:
- Value
Meaning
- 0
Successful
- 1
Nowait mode requested; user logging process busy
- 2
Parameter out of bounds
- 3
Request to open or write to a user logging process
not running
- 5
Incorrect mode parameter passed
- 6
Request denied; user logging process suspended
- 7
Illegal capability; user logging (LG) or system
supervisor (OP) capability required
- 8
Incorrect password passed
- 9
Error while writing to the user logging file
- 12
System out of disk space; user logging cannot proceed
- 13
Out of user logging entries
- 15
End-of-file on user logging file
- 16
Invalid user logging identifier
Operation Notes
The user logging facility establishes a logging buffer (LOGBUFF) entry
for every active process and increments the user count only at the first
OPENLOG call. Other counters keep track of the number of times
OPENLOG and CLOSELOG are called for each user; the counter is
incremented for every OPENLOG and decremented for every
CLOSELOG for each user. This ensures that the entry in
LOGBUFF is released only if it is the last CLOSELOG call
(that is, call counter = 0). The number of users and log entries are
independent of the number of times the OPENLOG/CLOSELOG
intrinsics are called within an application.
Related Information
- Commands
LOG
- Manual
User Logging Programmer's Guide
|