The R_DhcpDeleteMClientInfo method deletes the specified MADCAP client lease record from the MADCAP server. It also frees up the MADCAP client IPv4 address for redistribution.
DWORD R_DhcpDeleteMClientInfo( [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress, [in, ref] LPDHCP_SEARCH_INFO ClientInfo );
ServerIpAddress: The IP address/host name of the MADCAP server. This parameter is unused.
ClientInfo: This is a pointer of type DHCP_SEARCH_INFO (section 2.2.1.2.18), defining the key to be used to search the MADCAP client lease record that needs to be deleted from the MADCAP server.
Return Values: A 32-bit unsigned integer value that indicates return status. A return value ERROR_SUCCESS (0x00000000) indicates that the operation was completed successfully, else it contains a Win32 error code, as specified in [MS-ERREF]. This error code value can correspond to a DHCP-specific failure, which takes a value between 20000 and 20099, or any generic failure.
|
Return value/code |
Description |
|---|---|
|
0x00000000 ERROR_SUCCESS |
The call was successful. |
|
0x00004E2D ERROR_DHCP_JET_ERROR |
An error occurred while accessing the MADCAP server database. |
The opnum field value for this method is 12.
When processing this call, the MADCAP server MUST do the following:
Validate if this method is authorized for read/write access per section 3.5.5. If not, return the error ERROR_ACCESS_DENIED.
If SearchType contains DhcpClientName, return ERROR_INVALID_PARAMETER.
Iterate through the DHCPv4MClientsList ADM element of all the DHCPv4MScope entries in server ADM element DHCPv4MScopesList and retrieve the DHCPv4MClient entry corresponding to the ClientIpAddress or ClientHardwareAddress as specified by the SearchType in the SearchInfo (section 2.2.1.2.18).
If the DHCPv4MClient entry is not found, return ERROR_DHCP_JET_ERROR.
Delete the DHCPv4MClient entry from the DHCPv4MClientsList.
Return ERROR_SUCCESS.
Exceptions Thrown: No exceptions SHOULD be thrown beyond those thrown by the underlying RPC protocol specified in [MS-RPCE].