Expand Minimize

DhcpV6GetStatelessStoreParams function

The DhcpV6GetStatelessStoreParams function retrieves the current DHCPv6 stateless client inventory configuration settings at the server or scope level.

Syntax


DWORD DHCP_API_FUNCTION DhcpV6GetStatelessStoreParams(
  _In_opt_  LPWSTR ServerIpAddress,
  _In_      BOOL fServerLevel,
  _In_      DHCP_IPV6_ADDRESS SubnetAddress,
  _Out_     LPDHCPV6_STATELESS_PARAMS *Params
);

Parameters

ServerIpAddress [in, optional]

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

fServerLevel [in]

If TRUE the stateless client inventory configuration settings at server level are retrieved. Otherwise, the scope level configuration settings are retrieved.

SubnetAddress [in]

A DHCP_IPV6_ADDRESS structure that contains the IPv6 subnet address of the stateless client inventory configuration settings to be retrieved. If the value of fServerLevel is TRUE, this must be 0.

Params [out]

Pointer to a DHCPV6_STATELESS_PARAMS structure that contains the stateless client inventory configuration settings for a DHCPv6 server.

Return value

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.

ValueMeaning
ERROR_INVALID_PARAMETER

One or more of the parameters were invalid.

ERROR_DHCP_SUBNET_NOT_PRESENT

IPv6 subnet does not exist on the DHCPv6 server.

 

Remarks

Params should be free using DhcpRpcFreeMemory.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

See also

DhcpV6GetStatelessStatistics
DhcpV6SetStatelessStoreParams

 

 

Community Additions

ADD
Show:
© 2014 Microsoft