Windows Dev Center

Expand Minimize

DhcpSetOptionInfoV5 function

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

ServerIpAddress [in]

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

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.

ValueMeaning
DHCP_FLAGS_OPTION_IS_VENDOR

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

 

OptionID [in]

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

ClassName [in]

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

VendorName [in]

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.

OptionInfo [in]

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 codeDescription
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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

See also

DhcpGetOptionInfoV5
DHCP_OPTION

 

 

Community Additions

ADD
Show:
© 2015 Microsoft