Skip to content

Latest commit

 

History

History
140 lines (115 loc) · 3.69 KB

nf-dhcpsapi-dhcpcreateoptionv6.md

File metadata and controls

140 lines (115 loc) · 3.69 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:dhcpsapi.DhcpCreateOptionV6
DhcpCreateOptionV6 function (dhcpsapi.h)
The DhcpCreateOptionV6 function creates a DHCP option.
DHCP_FLAGS_OPTION_IS_VENDOR
DhcpCreateOptionV6
DhcpCreateOptionV6 function [DHCP]
dhcp.dhcpcreateoptionv6
dhcpsapi/DhcpCreateOptionV6
dhcp\dhcpcreateoptionv6.htm
DHCP
c1a54d82-3fea-4f65-be46-d2a81d639429
12/05/2018
DHCP_FLAGS_OPTION_IS_VENDOR, DhcpCreateOptionV6, DhcpCreateOptionV6 function [DHCP], dhcp.dhcpcreateoptionv6, dhcpsapi/DhcpCreateOptionV6
dhcpsapi.h
Windows
None supported
Windows Server 2008 [desktop apps only]
Dhcpsapi.lib
Dhcpsapi.dll
Windows
19H1
DhcpCreateOptionV6
dhcpsapi/DhcpCreateOptionV6
c++
APIRef
kbSyntax
DllExport
Dhcpsapi.dll
DhcpCreateOptionV6

DhcpCreateOptionV6 function

-description

The DhcpCreateOptionV6 function creates a DHCP option.

-parameters

-param ServerIpAddress [in]

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

-param Flags [in]

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 must be set if the option is provided by a vendor.

-param OptionId [in]

DHCP_OPTION_ID value that contains the unique option ID number (also called an "option code") of the new option. Many of these option ID numbers are defined; a complete list of standard DHCP and BOOTP option codes can be found at http://www.ietf.org/rfc/rfc3315.txt.

-param ClassName [in, optional]

Unicode string that specifies the name of the DHCP class that will contain this option. This field is optional.

-param VendorName [in, optional]

Unicode string that contains a vendor name string if the class specified in ClassName is a vendor-specific class.

-param OptionInfo [in]

DHCP_OPTION structure that contains information describing the new DHCP option, including the name, an optional comment, and any related data items.

-returns

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_INVALID_PARAMETER
The parameters were invalid.
ERROR_DUPLICATE_TAG
The specified scope already exists.
ERROR_FILE_NOT_FOUND
The vendor name is invalid. Typically, this is because the vendor name is greater than 255 characters in length.