DosLogRead: Difference between revisions
Created page with "==Description== This function is part of the 16 Bit Error Logging API's for IBM OS/2 Version 2.1. ==Syntax== <PRE> APIRET16 APIENTRY16 DosLogRead((USHORT) LogHandl..." |
mNo edit summary |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
This function is part of the 16-Bit Error Logging APIs for IBM OS/2 Version 2.1. | |||
This function is part of the 16 Bit Error Logging | |||
==Syntax== | |||
DosLogRead (LogHandle, Length, LogBuffer, ReadSize) | |||
==Parameters== | ==Parameters== | ||
; | ;LogHandle (USHORT): is the named pipe handle returned by DosLogRegister() | ||
;Length (USHORT): is the length (in words) of the caller's log buffer | |||
; Length : is the length (in words) of the caller's log buffer | ;LogBuffer ([[PVOID]]): is the address of the caller's buffer, into which the system Error Logging facility will place a single Error Log entry packet (formatted in the manner of the 16 bit DosLogEntry API). | ||
;ReadSize (PUSHORT): is the address of a word, into which the system Error Logging facility will place the number of bytes that it wrote into the caller's log buffer. If a zero is returned here, then there was no Error Log packet to return. | |||
; LogBuffer : is the address of the caller's buffer, into which the system Error Logging facility will place a single Error Log entry packet (formatted in the manner of the 16 bit DosLogEntry API). | |||
; ReadSize : is the address of a word, into which the system Error Logging facility will place the number of bytes that it wrote into the caller's log buffer. If a zero is returned here, then there was no Error Log packet to return. | |||
==Return Code== | ==Return Code== | ||
APIRET16 APIENTRY16 | |||
DosLogRead returns the following values: | DosLogRead returns the following values: | ||
* indicating Success. : non-zero | * indicating Success. : non-zero | ||
* indicating error : 0 | |||
* indicating error : 0 | |||
Possible reasons for failure: | Possible reasons for failure: | ||
* Invalid log handle | |||
* Invalid log handle | * Facility unavailable | ||
* Facility unavailable | |||
* Buffer too small | * Buffer too small | ||
==Remarks== | ==Remarks== | ||
In order to resolve successfully DosLogRead function calls in your program, the following lines must be added to the Linker Definition (DEF) file: | In order to resolve successfully DosLogRead function calls in your program, the following lines must be added to the Linker Definition (DEF) file: | ||
IMPORTS | IMPORTS | ||
DOSLOGREAD=DOSCALL1.196 | DOSLOGREAD=DOSCALL1.196 | ||
DosLogRead returns Error Log entries that are formatted in the manner of the 16 bit DosLogEntry API. | DosLogRead returns Error Log entries that are formatted in the manner of the 16-bit DosLogEntry API. | ||
[[Category: | [[Category:Dos]] | ||
Latest revision as of 09:21, 24 November 2019
This function is part of the 16-Bit Error Logging APIs for IBM OS/2 Version 2.1.
Syntax
DosLogRead (LogHandle, Length, LogBuffer, ReadSize)
Parameters
- LogHandle (USHORT)
- is the named pipe handle returned by DosLogRegister()
- Length (USHORT)
- is the length (in words) of the caller's log buffer
- LogBuffer (PVOID)
- is the address of the caller's buffer, into which the system Error Logging facility will place a single Error Log entry packet (formatted in the manner of the 16 bit DosLogEntry API).
- ReadSize (PUSHORT)
- is the address of a word, into which the system Error Logging facility will place the number of bytes that it wrote into the caller's log buffer. If a zero is returned here, then there was no Error Log packet to return.
Return Code
APIRET16 APIENTRY16
DosLogRead returns the following values:
- indicating Success. : non-zero
- indicating error : 0
Possible reasons for failure:
- Invalid log handle
- Facility unavailable
- Buffer too small
Remarks
In order to resolve successfully DosLogRead function calls in your program, the following lines must be added to the Linker Definition (DEF) file:
IMPORTS DOSLOGREAD=DOSCALL1.196
DosLogRead returns Error Log entries that are formatted in the manner of the 16-bit DosLogEntry API.