DosLogRead

The description of the OS/2 2.0 version of the DosLogRead API follows:

        APIRET16 APIENTRY16 DosLogRead((USHORT) LogHandle,
                                      (USHORT) Length,
                                      (PVOID) LogBuffer,
                                      (PUSHORT) ReadSize)
32-bit code Example using CSet/2

Parameters

LogHandle

is the named pipe handle returned by DosLogRegister()
Length
is the length (in words) of the caller's log buffer
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.

Returns

Return code

DosLogRead returns the following values:

• indicating Success.

  non-zero

  indicating error

  Possible reasons for failure:

  Invalid log handle
  Facility unavailable
  Buffer too small

  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.

  ---

  [Back: DosLogEntry]
  [Next: Error Log Entry Formatting DLL Routines]