DhcpUndoRequestParams function

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

Syntax

DWORD DhcpUndoRequestParams(
  DWORD  Flags,
  LPVOID Reserved,
  LPWSTR AdapterName,
  LPWSTR RequestIdStr
);

Parameters

Flags

Reserved. Must be zero.

Reserved

Reserved for future use. Must be set to NULL.

AdapterName

Name of the adapter for which information is no longer required. Must be under 256 characters.

Note  This parameter is no longer used.
 

RequestIdStr

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

Return Value

Returns ERROR_SUCCESS upon successful completion. Otherwise, returns a Windows error code.

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.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header dhcpcsdk.h
Library Dhcpcsvc.lib
DLL Dhcpcsvc.dll

See Also

DHCP Functions

DhcpCApiInitialize

DhcpRequestParams