Skip to content

Latest commit

 

History

History
88 lines (67 loc) · 2.88 KB

nf-dhcpsapi-dhcpgetoptionvalue.md

File metadata and controls

88 lines (67 loc) · 2.88 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.DhcpGetOptionValue
DhcpGetOptionValue function (dhcpsapi.h)
The DhcpGetOptionValue function retrieves a DHCP option value (the option code and associated data) for a particular scope.
DhcpGetOptionValue
DhcpGetOptionValue function [DHCP]
dhcp.dhcpgetoptionvalue
dhcpsapi/DhcpGetOptionValue
dhcp\dhcpgetoptionvalue.htm
DHCP
7dca800f-2427-44b1-bc92-f9db54de08a5
12/05/2018
DhcpGetOptionValue, DhcpGetOptionValue function [DHCP], dhcp.dhcpgetoptionvalue, dhcpsapi/DhcpGetOptionValue
dhcpsapi.h
Windows
None supported
Windows 2000 Server [desktop apps only]
Dhcpsapi.lib
Dhcpsapi.dll
Windows
19H1
DhcpGetOptionValue
dhcpsapi/DhcpGetOptionValue
c++
APIRef
kbSyntax
DllExport
Dhcpsapi.dll
DhcpGetOptionValue

DhcpGetOptionValue function

-description

The DhcpGetOptionValue function retrieves a DHCP option value (the option code and associated data) for a particular scope.

-parameters

-param ServerIpAddress [in]

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

-param OptionID [in]

DHCP_OPTION_ID value that specifies the code for the option value to retrieve.

-param ScopeInfo [in]

DHCP_OPTION_SCOPE_INFO structure that contains information on the scope where the option value is set.

-param OptionValue [out]

DHCP_OPTION_VALUE structure that contains the returned option code and data.

Note  

The memory for this parameter must be free using DhcpRpcFreeMemory.

 

-returns

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

-remarks

This function requires host byte ordering for all DHCP_IP_ADDRESS values in parameter structures.

-see-also

DHCP_OPTION_VALUE