3.1.4.10 R_DhcpSetOptionInfo (Opnum 9)
The R_DhcpSetOptionInfo method modifies the option definition of the specified option for the default user class and vendor class pair at the default option level. There is an extension method R_DhcpSetOptionInfoV5 that sets the option definition for a specific user class and vendor class pair.
-
DWORD R_DhcpSetOptionInfo( [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress, [in] DHCP_OPTION_ID OptionID, [in, ref] LPDHCP_OPTION OptionInfo );
ServerIpAddress: The IP address/host name of the DHCP server. This parameter is unused.
OptionID: This is of type DHCP_OPTION_ID (section 2.2.1.2.3), containing the option identifier for the option being modified.
OptionInfo: This is a pointer of type DHCP_OPTION (section 2.2.1.2.25) structure, containing the option definition for the option being modified.
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.
0x00004E2A
ERROR_DHCP_OPTION_NOT_PRESENT
The specified option definition does not exist on the DHCP server database.
0x00004E2D
ERROR_DHCP_JET_ERROR
An error occurred while accessing the DHCP server database.
The opnum field value for this method is 9.
When processing this call, the DHCP server MUST do the following:
Validate whether this method is authorized for read/write access per section 3.5.5. If not, return the error ERROR_ACCESS_DENIED.
Validate the DefaultValue data structure, pointed to by the OptionInfo parameter, by checking that its Elements member is not NULL and that its NumElements member is not zero. If either check fails, return ERROR_INVALID_PARAMETER.
Iterate though the server Abstract Data Model (ADM) element DHCPv4OptionDefList, and retrieve the DHCPv4ClassedOptDefList ADM element corresponding to the DHCPv4OptionDef ADM element entry whose UserClass and VendorClass ADM element fields are NULL. If there is no DHCPv4OptionDef ADM element entry whose UserClass and VendorClass fields are NULL, return ERROR_DHCP_CLASS_NOT_FOUND.
Iterate through the DHCPv4ClassedOptDefList ADM element; if there is no DHCPv4ClassedOptDef ADM element entry corresponding to the OptionID parameter, return ERROR_DHCP_OPTION_NOT_PRESENT.
Retrieve the DHCPv4ClassedOptDef ADM element entry corresponding to the OptionID parameter, and modify it with information in OptionInfo parameter. Return ERROR_SUCCESS.
Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].