DosLogRead

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.

Syntax

        APIRET16 APIENTRY16 DosLogRead((USHORT) LogHandle,
                                      (USHORT) Length,
                                      (PVOID) LogBuffer,
                                      (PUSHORT) ReadSize)

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.

Return Code

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.