DosLogRead: Difference between revisions

Revision as of 16:26, 25 February 2017

This function is part of the 16 Bit Error Logging API's for IBM OS/2 Version 2.1.

This is a legacy function. It is recommended to find a newer replacement.

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.

@@ Line 1: / Line 1: @@
-[[image:legacy.png]]
+This function is part of the 16 Bit Error Logging API's for IBM OS/2 Version 2.1.
-This is a legacy function. It is recommended to find a newer replacement.
-==Description==
-This function is part of the 16 Bit Error Logging API's for IBM OS/2 Version 2.1.
+This is a legacy function. It is recommended to find a newer replacement.
+==Syntax==
+ DosLogRead (LogHandle, Length, LogBuffer, ReadSize)
-==Syntax==
-<PRE>
-        APIRET16 APIENTRY16 DosLogRead((USHORT) LogHandle,
-                                      (USHORT) Length,
-                                      (PVOID) LogBuffer,
-                                      (PUSHORT) ReadSize)
-</PRE>
 ==Parameters==
-;  LogHandle : is the named pipe handle returned by DosLogRegister()
+;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==
+ APIRET16 APIENTRY16
 DosLogRead returns the following values:
 * indicating Success. : non-zero
+* indicating error : 0
-* indicating error : 0
 Possible reasons for failure:
+* Invalid log handle
-* Invalid log handle
+* Facility unavailable
-* 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.
+DosLogRead returns Error Log entries that are formatted in the manner of the 16-bit DosLogEntry API.
-==Example Code==
-==Related Functions==
-[[Category:The OS/2 API Project]]
+[[Category:Dos]]