3.1.4.46 R_DhcpSetClientInfoVQ (Opnum 45)

The R_DhcpSetClientInfoVQ method sets/modifies an existing DHCPv4 client lease record on the DHCPv4 server database.

 DWORD R_DhcpSetClientInfoVQ(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [in, ref] LPDHCP_CLIENT_INFO_VQ ClientInfo
 );

ServerIpAddress: The IP address/host name of the DHCP server. This parameter is unused.

ClientInfo: A pointer of type DHCP_CLIENT_INFO_VQ (section 2.2.1.2.19) structure that contains the DHCPv4 client lease record information that needs to be modified on the DHCPv4 server database. The caller MUST pass the ClientIPAddress and ClientHardwareAddress members when modifying a DHCPv4 client lease record stored in the DHCPv4 server database. The ClientHardwareAddress member represents a DHCPv4 client-identifier (section 2.2.1.2.5.1). The members ClientName, ClientComment, ClientLeaseExpires, and OwnerHost are modified in the DHCPv4 client lease record identified by the ClientIPAddress member.

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 DHCP server database or the client entry is not present in the database.

The opnum field value for this method is 45.

When processing this call, the DHCP server MUST do the following:

Exceptions Thrown: No exceptions SHOULD be thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].