BEGINLOG [ MPE/iX Intrinsics Reference Manual ] MPE/iX 5.0 Documentation
MPE/iX Intrinsics Reference Manual
BEGINLOG
NM and CM callable.
Posts a special record to the user logging file to mark the beginning of
a logical transaction. When BEGINLOG is called, the logging memory
buffer is flushed to ensure that the record gets to the logging file.
User logging (LG) or system supervisor (OP) capability is required.
Syntax
_________________________________________________
| |
| I32 U16A I16 I16 I16 |
| BEGINLOG(index,data,length,mode,logstatus)|
_________________________________________________
Parameters
index 32-bit signed integer by reference (required)
Passes access information to the user logging
system. This is the value returned in the index
parameter of the OPENLOG intrinsic.
data 16-bit unsigned integer array (required)
Passes the information to be logged. A log record
contains 128 half words where 119 are available for
writing data. For the most efficient use of log
file space, structure arrays with lengths in
multiples of 119 half words.
length 16-bit signed integer by reference (required)
Passes the length of the data. A positive value
indicates half words; a negative value indicates
bytes. If the length is greater than 119 half
words (or 238 bytes), the information in data is
divided into two or more physical log records.
mode 16-bit signed integer by reference (required)
Passes a value indicating whether the logging
process should suspend the process if it cannot
complete the request for service immediately. If
it is not possible to log the transaction and mode
is set to nowait, the BEGINLOG intrinsic indicates,
through logstatus, that it could not complete the
request:
Value Meaning
0 Wait
1 Nowait
logstatus 16-bit signed integer by reference (required)
Returns a value, indicating the success/failure of
the intrinsic call:
Value Meaning
0 Successful
1 Nowait mode requested, and user logging process is
busy
2 Parameter out of bounds
4 Incorrect index parameter passed
5 Incorrect mode parameter passed
9 Error occurred while writing
12 System out of disk space, user logging cannot proceed
14 Invalid access
15 End-of-file
Operation Notes
Use the data parameter of this intrinsic to post user data to the logging
file. This use of BEGINLOG is similar to using the WRITELOG intrinsic,
but also denotes the beginning of a logical transaction.
Related Information
Intrinsics ENDLOG, WRITELOG
Commands None
Manuals User Logging Programmer's Guide (32650-90027)
MPE/iX 5.0 Documentation