View source for DosLogRead

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.

[[Category:Dos]]