NetErrorLogClear or Net32ErrorLogClear

The NetErrorLogClear API clears (and optionally saves) the error log file of a computer.

Restrictions

This API can be called from DLS and OS/2 workstations, but DLS workstations can issue this call only to a remote LAN Server workstation. Administrator authority is required to call this API.

Syntax

#include <netcons.h>
#include <errlog.h>
 
NetErrorLogClear(pszServername, pszBackupFile,
                 reserved);                /* 16 bit */
 
Net32ErrorLogClear(pszServername, pszBackupFile,
                 reserved);                /* 32 bit */

Parameters

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

pszBackupFile

(const unsigned char LSFAR *) points to an ASCIIZ string assigning a name for an optional backup file. The calling application must have write privileges for the path specified by this parameter. In addition, the path name must be accessible by the OS/2 DosMove function. If the path name is relative, it is assumed to be relative to the IBMLAN\LOGS directory.

A null pointer indicates that NetErrorLogClear is not to save the error log entries.

reserved
(unsigned char LSFAR *) is a null pointer.
Return Codes

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_NOT_ENOUGH_MEMORY │ 8 │ Sufficient memory is not available. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_SHARING_VIOLATION │ 32 │ A sharing violation occurred. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_BAD_NETPATH │ 53 │ The network path cannot be found. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_NETWORK_ACCESS_DENIED │ 65 │ Network access is denied. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_INVALID_PARAMETER │ 87 │ At least one parameter value is not │
│ │ │ valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_INVALID_NAME │ 123 │ There is an incorrect character or │
│ │ │ incorrectly formed file system name. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_FILENAME_EXCED_RANGE │ 206. │ The file name is longer than 8 charac- │
│ │ │ ters or the extension is longer than 3 │
│ │ │ characters. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NetNotStarted │ 2102 │ The redirector NETWKSTA.200 has not │
│ │ │ been started. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_RemoteOnly │ 2106 │ This operation is not supported on │
│ │ │ workstations. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_InternalError │ 2140 │ An internal error has occurred. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BadTransactConfig │ 2141 │ The server is not configured for │
│ │ │ transactions. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_InvalidAPI │ 2142 │ The requested API is not supported on │
│ │ │ the remote server. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_InvalidComputer │ 2351 │ The specified computer name is not │
│ │ │ valid. │
└─────────────────────────────┴───────┴────────────────────────────────────────┘


Other codes could be returned from the following functions:

• DosDelete
  
• DosFsCtl
  
• DosGetShrSeg
  
• DosNewSize
  
• DosMove
  
• DosOpen
Remarks

NetErrorLogClear fails if another process currently is using the error log file.

The NetErrorLogWrite function 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. Therefore, applications periodically should clear the error log file of outdated information.

To set a maximum size for the error log file, use one of the following methods:

• Use the NET CONFIG command with the /MAXERRORLOG option to override the option for a logon session, or edit the IBMLAN.INI file to change the value of the capacity parameter that determines the size of the error log. (For more information, see the LAN Server Network Administrator Reference Volume 2: Performance Tuning.)

• Set the MAXERRORLOG parameter in the IBMLAN.INI file. (For a description of the IBMLAN.INI file, see the IBM Directory and Security Server Commands and Utilities.)

• Call the NetWkstaSetInfo function with the wki0_errlogsz parameter.
Related Information

For information about writing an entry to the error log file, see Error Logging - NetErrorLogWrite.

---

[Back: Related Information]
[Next: NetErrorLogRead or Net32ErrorLogRead]