Skip to content

Latest commit

 

History

History
146 lines (111 loc) · 3.98 KB

nf-dhcpsapi-dhcpv4getalloptionvalues.md

File metadata and controls

146 lines (111 loc) · 3.98 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.DhcpV4GetAllOptionValues
DhcpV4GetAllOptionValues function (dhcpsapi.h)
Retrieves an array of DHCP option values (the option code and associated data) for a particular scope.
DHCP_FLAGS_OPTION_IS_VENDOR
DhcpV4GetAllOptionValues
DhcpV4GetAllOptionValues function [DHCP]
dhcp.dhcpv4getalloptionvalues
dhcpsapi/DhcpV4GetAllOptionValues
dhcp\dhcpv4getalloptionvalues.htm
DHCP
3c2fff2f-3d79-4e0d-8a31-9917088b1413
12/05/2018
DHCP_FLAGS_OPTION_IS_VENDOR, DhcpV4GetAllOptionValues, DhcpV4GetAllOptionValues function [DHCP], dhcp.dhcpv4getalloptionvalues, dhcpsapi/DhcpV4GetAllOptionValues
dhcpsapi.h
Windows
None supported
Windows Server 2012 [desktop apps only]
Dhcpsapi.lib
Dhcpsapi.dll
Windows
19H1
DhcpV4GetAllOptionValues
dhcpsapi/DhcpV4GetAllOptionValues
c++
APIRef
kbSyntax
DllExport
Dhcpsapi.dll
DhcpV4GetAllOptionValues

DhcpV4GetAllOptionValues function

-description

The DhcpV4GetAllOptionValues function retrieves an array of DHCP option values (the option code and associated data) for a particular scope.

-parameters

-param ServerIpAddress [in, optional]

Pointer to a null-terminated Unicode string that represents the IP address or hostname of the DHCP server.

-param Flags [in]

Indicates whether the option values are for a specific or default vendor.

Flags Meaning
0x00000000
The option values are retrieved for a default vendor.
DHCP_FLAGS_OPTION_IS_VENDOR
0x00000003
The option values are retrieved for specific vendors.

-param ScopeInfo [in]

A pointer to a DHCP_OPTION_SCOPE_INFO structure that contains information on the scope of the option values to retrieve.

-param Values [out]

Pointer to a DHCP_ALL_OPTION_VALUES_PB structure that contains the retrieved option values for the scope specified in ScopeInfo.

There is one option value in the array for each vendor/policy pair defined on the DHCP server.

-returns

If the function succeeds, it returns ERROR_SUCCESS.

If the function fails, it returns one of the following or an error code from DHCP Server Management API Error Codes.

Value Meaning
ERROR_INVALID_PARAMETER
One or more of the parameters were invalid.

-remarks

Values should be free using DhcpRpcFreeMemory.

-see-also

DhcpV4GetOptionValue

DhcpV4RemoveOptionValue

DhcpV4SetOptionValue

DhcpV4SetOptionValues