Edit

Share via


DhcpSetOptionInfo function (dhcpsapi.h)

The DhcpSetOptionInfo function

modifies the option definition of the specified option for the default user class and vendor class at the default option level.

Syntax

DWORD DHCP_API_FUNCTION DhcpSetOptionInfo(
  [in] DHCP_CONST WCHAR       *ServerIpAddress,
  [in] DHCP_OPTION_ID         OptionID,
  [in] DHCP_CONST DHCP_OPTION *OptionInfo
);

Parameters

[in] ServerIpAddress

Pointer to a Unicode string that specifies the IP address or hostname of the DHCP server.

[in] OptionID

DHCP_OPTION_ID value that contains the code uniquely identifying a specific DHCP option.

[in] OptionInfo

Pointer to a DHCP_OPTION structure that contains information on the option specified by OptionID.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes.

Return code Description
ERROR_DHCP_JET_ERROR
An error occurred while accessing the DHCP server database.
ERROR_DHCP_OPTION_NOT_PRESENT
The specified option definition could not be found in the DHCP server database.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header dhcpsapi.h
Library Dhcpsapi.lib
DLL Dhcpsapi.dll

See also

DHCP_OPTION

DhcpGetOptionInfo

DhcpSetOptionInfoV5