3.1.4.41 R_DhcpServerGetConfigV4 (Opnum 40)
The R_DhcpServerGetConfigV4 method retrieves the current DHCPv4 server setting. The caller of this function can free the memory pointed to by the ConfigInfo parameter by calling the function midl_user_free, specified in section 3.
-
DWORD R_DhcpServerGetConfigV4( [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress, [out] LPDHCP_SERVER_CONFIG_INFO_V4* ConfigInfo );
ServerIpAddress: The IP address/host name of the DHCP server. This parameter is unused.
ConfigInfo: This is a pointer of type LPDHCP_SERVER_CONFIG_INFO_V4 that points to the location where the DHCPv4 server settings are retrieved. The caller of this method can free up this structure after use.
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.
The opnum field value for this method is 40.
When processing this call, the DHCP server MUST do the following:
Validate if this method is authorized for read access per section 3.5.4. If not, return the error ERROR_ACCESS_DENIED.
Retrieve all the fields in the server ADM element DHCPv4ServerConfigInfo which have corresponding fields in the DHCP_SERVER_CONFIG_INFO_V4 structure, and copy them in the locations pointed to by the ConfigInfo parameter.
Return ERROR_SUCCESS.
Exceptions Thrown: No exceptions SHOULD be thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].