Edit

Share via

DhcpSetOptionInfoV5 function (dhcpsapi.h)

  • Article

The DhcpSetOptionInfoV5 function sets information for a specific DHCP option.

Syntax

DWORD DhcpSetOptionInfoV5(
  [in] LPWSTR         ServerIpAddress,
  [in] DWORD          Flags,
  [in] DHCP_OPTION_ID OptionID,
  [in] LPWSTR         ClassName,
  [in] LPWSTR         VendorName,
  [in] LPDHCP_OPTION  OptionInfo
);

Parameters

[in] ServerIpAddress

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

[in] Flags

Specifies a bit flag that indicates whether or not the option is vendor-specific. If it is not, this parameter should be 0.

Value Meaning
DHCP_FLAGS_OPTION_IS_VENDOR
 This flag should be set if the option is provided by a vendor.

[in] OptionID

DHCP_OPTION_ID value that specifies the code for a specific DHCP option.

[in] ClassName

Pointer to a Unicode string that specifies the DHCP class name of the option. This parameter is optional.

[in] VendorName

Pointer to a Unicode string that specifies the vendor of the option. This parameter is optional, and should be NULL when Flags is not set to DHCP_FLAGS_OPTION_IS_VENDOR.

[in] OptionInfo

Pointer to a DHCP_OPTION structure that contains the 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_ACCESS_DENIED
 This call was performed by a client who is not a member of the "DHCP Administrators" security group.
ERROR_DHCP_JET_ERROR
 An error occurred while accessing the DHCPv6 server's database.
ERROR_DHCP_CLASS_NOT_FOUND
 The provided class name is either incorrect or does not exist on the DHCP server.

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

DhcpGetOptionInfoV5