NetAuditClear or Net32AuditClear

The NetAuditClear API clears the audit log file and, optionally, saves the contents to another file.

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 <audit.h>
 
NetAuditClear(pszServername, pszBackupFile,
              reserved);     /* 16 bit */
 
Net32AuditClear(pszServername, pszBackupFile,
              reserved);     /* 32 bit */

Parameters

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

pszBackupFile

(const unsigned char LSFAR *) optionally points to an ASCIIZ string containing the name for a backup file. The calling application must have write privilege for the path specified by pszBackupFile. The path name also 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 tells NetAuditClear not to save the audit log entries.

reserved
(unsigned char LSFAR *) must be NULL.
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_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_WkstaNotStarted │ 2138 │ The Requester service has not been │
│ │ │ started. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ 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
  
• DosMove
  
• DosOpen
Remarks

The NetAuditWrite API (see Auditing - NetAuditWrite) issues an admin alert when the audit log file reaches 80% capacity and again when the file reaches 100% capacity. At 100%, NetAuditWrite fails. Therefore, applications should periodically clear the audit log file of outdated information.

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

• Use the NET CONFIG command with the /MAXAUDITLOG option (see the LAN Server Commands and Utilities for more information).

• Set the maxauditlog parameter in the IBMLAN.INI file (see the LAN Server Network Administrator Reference Volume 2: Performance Tuning for a description of IBMLAN.INI).

• Call the NetServerSetInfo API with the sv_maxauditsz parameter.
Related Information

For information about:

• Getting the status of audit log file capacity, see Alert - NetAlertRaise. 
  Writing an entry to the audit log file, see Auditing - NetAuditWrite.

  ---

  [Back: Related Information]
  [Next: NetAuditRead or Net32AuditRead]