Edit

Share via

DhcpAuditLogGetParams function (dhcpsapi.h)

  • Article

The DhcpAuditLogGetParams function returns the audit log configuration settings from the DHCP server.

Syntax

DWORD DhcpAuditLogGetParams(
  [in]  LPWSTR ServerIpAddress,
  [in]  DWORD  Flags,
  [out] LPWSTR *AuditLogDir,
  [out] DWORD  *DiskCheckInterval,
  [out] DWORD  *MaxLogFilesSize,
  [out] DWORD  *MinSpaceOnDisk
);

Parameters

[in] ServerIpAddress

Pointer to a Unicode string that specifies the IP address or hostname of the DHCP server.

[in] Flags

Specifies a set of bit flags for filtering the audit log. Currently, this parameter is reserved and should be set to 0.

[out] AuditLogDir

Unicode string that contains the directory where the audit log is stored as an absolute path within the file system.

[out] DiskCheckInterval

Specifies the disk check interval for attempting to write the audit log to the specified file as the number of logged DHCP server events that should occur between checks. The default is 50 DHCP server events between checks.

[out] MaxLogFilesSize

Specifies the maximum log file size, in bytes.

[out] MinSpaceOnDisk

Specifies the minimum required disk space, in bytes, for audit log storage.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes.

Return code Description
ERROR_ACCESS_DENIED
 This call was performed by a client who is not a member of the "DHCP Administrators" security group.
ERROR_DHCP_JET_ERROR
 An error occurred while accessing the DHCP server's database.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header dhcpsapi.h
Library Dhcpsapi.lib
DLL Dhcpsapi.dll

See also

DhcpAuditLogSetParams