NetErrorLogWrite or Net32ErrorLogWrite

The NetErrorLogWrite (local) API writes an entry to the error log file. Using the OS/2 program, the entry goes in the NET.ERR file.

Restrictions

A call to this API must be issued locally.

#include <netcons.h>
#include <errlog.h>
 
NetErrorLogWrite(reserved1, code, component,
                 buf, usBuflen, insbuf,
                 nstrings, reserved2);    /* 16 bit  *
 
Net32ErrorLogWrite(reserved1, code, component,
                 buf, ulBuflen, insbuf,
                 nstrings, reserved2);    /* 32 bit *

See Common Parameter Definitions for descriptions of parameters not defined here.

reserved1

(unsigned char LSFAR *) must be a null pointer.

code

(unsigned short) specifies the error code of the network error that occurred.

component

(const unsigned char LSFAR *) points to an ASCIIZ string specifying which software component encountered the error.

buf

(const unsigned char LSFAR *) points to the raw data associated with the error condition. This parameter can be null. If non-null, this parameter points to data that is typically displayed in hexadecimal format by applications reading the error log, such as the NET.EXE application in the NET ERROR command. Examples of raw data include invalid network data or invalid configuration strings that an application encounters during initialization or execution.

insbuf

(const unsigned char LSFAR *) points to the ASCIIZ strings containing the error message. This parameter can be null. If non-null, this parameter points to one or more ASCIIZ strings. Applications that call either the NetErrorLogRead or Net32ErrorLogRead API use this parameter in the DosGetMessage API, which uses the ASCIIZ strings to replace any metacharacters (%1, %2, and so on) found in the message.

nstrings

insbuf

reserved2

(unsigned char LSFAR *) must be a null pointer.

The following table lists the return codes most significant to this API. (See API Return Codes for a complete list of return codes.) кФФФФФФФФФФФФФФФФФФФФФФФФФФФФФТФФФФФФФТФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФПГSYMBOLICCONSTANT ГVALUEГMEANING Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_Success Г 0 Г No errors were encountered. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_PATH_NOT_FOUND Г 3 Г The path was not found. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_ACCESS_DENIED Г 5 Г Administrator privilege is required. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_SHARING_VIOLATION Г 32 Г A sharing violation occurred. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_NOT_SUPPORTED Г 50 Г This request is not supported by the Г
Г Г Г network. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_BAD_NETPATH Г 53 Г The network path cannot be found. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_INVALID_PARAMETER Г 87 Г At least one parameter value is not Г
Г Г Г valid. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_NetNotStarted Г 2102 Г The redirector NETWKSTA.200 has not Г
Г Г Г been started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_WkstaNotStarted Г 2138 Г The Requester service has not been Г
Г Г Г started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_LogOverflow Г 2377 Г This log file exceeds the maximum Г
Г Г Г defined size. Г
РФФФФФФФФФФФФФФФФФФФФФФФФФФФФФСФФФФФФФСФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФй

The NetErrorLogWrite API internally calls the appropriate OS/2 functions to open and close the error log file.

This API issues an error log alert (with NetAlertRaise) each time an entry is written to the error log file. In addition, the NetErrorLogWrite API issues one admin alert when the error log file reaches 80% capacity and another when the file reaches 100% capacity. At 100% error log file capacity, NetErrorLogWrite fails, returning the error code NERR_LogOverflow.

For information about:

Clearing the error log file, see Error Logging - NetErrorLogClear.
Closing the error log file, see DosClose in the OS/2 Technical Library, Programming Guide Volume 1.
Error codes, see API Return Codes.
Limiting the size of the error log file, see Server - NetServerSetInfo.
Retrieving the size of the error log file, see Server - NetServerGetInfo.

[Back]

[Next]