DhcpUndoRequestParams

The DhcpUndoRequestParams function removes persistent requests previously made with a DhcpRequestParams function call.

DWORD
APIENTRY
DhcpUndoRequestParams(
  DWORD dwFlags,
  LPVOID pReserved,
  LPWSTR pszAdapterName,
  LPWSTR pszRequestIdStr
);

Parameters

dwFlags

[in] Must be zero.

pReserved

[in] Reserved for future use. Must be set to NULL.

pszAdapterName

[in] Name of the adapter for which information is no longer required.

pszRequestIdStr

[in] Application Identifier (ID) originally used to make a persistent request. This string must match the pszRequestIdStr parameter used in the DhcpRequestParams function call that obtained the corresponding persistent request. Note that this must match the previous application ID used, and must be a printable string with no special characters (for example, commas, backslashes, colons, or other illegal characters may not be used).

Remarks

Persistent requests are typically made by the setup or installer process associated with the application. When appropriate, the setup or installer process would likely make the DhcpUndoRequestParams function call to cancel its associated persistent request.

Return Values

Returns ERROR_SUCCESS upon successful completion. Otherwise, returns Win32 error codes.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Dhcpcsdk.h.
  Library: Use Dhcpcsvc.lib.

See Also

DHCP Overview, DHCP Functions, DhcpCApiInitialize, DhcpRequestParams