Edit

Share via

DhcpServerSetConfigV6 function (dhcpsapi.h)

  • Article

The DhcpServerSetConfigV6 function sets the DHCPv6 server configuration data at the scope or server level.

Syntax

DWORD DHCP_API_FUNCTION DhcpServerSetConfigV6(
  [in] DHCP_CONST WCHAR             *ServerIpAddress,
  [in] LPDHCP_OPTION_SCOPE_INFO6    ScopeInfo,
  [in] DWORD                        FieldsToSet,
  [in] LPDHCP_SERVER_CONFIG_INFO_V6 ConfigInfo
);

Parameters

[in] ServerIpAddress

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

[in] ScopeInfo

Pointer to a DHCP_OPTION_SCOPE_INFO6 structure that contains the configuration information at the scope or server level.

[in] FieldsToSet

Specifies the set of value that indicate the type of configuration information provided in ConfigInfo. Only one of these values may be set per call.

Value Meaning
Set_UnicastFlag
0x00000001
 Not used.
Set_RapidCommitFlag
0x00000002
 Not used.
Set_PreferredLifetime
0x00000004
 Sets the preferred lifetime value for a non-temporary IPv6 address.
Set_ValidLifetime
0x00000008
 Sets the valid lifetime value for a non-temporary IPv6 address.
Set_T1
0x00000010
 Sets the T1 time value.
Set_T2
0x00000020
 Sets the T2 time value.
Set_PreferredLifetimeIATA
0x00000040
 Not used.
Set_ValidLifetimeIATA
0x00000080
 Not used.
Set_AuditLogState
0x00000800
 Sets the audit log state in the registry.

[in] ConfigInfo

Pointer to a DHCP_SERVER_CONFIG_INFO_V6 structure that contains configuration information of the type indicated by the value supplied in FieldsToSet.

Return value

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_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 DHCP server's database.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header dhcpsapi.h
Library Dhcpsapi.lib
DLL Dhcpsapi.dll

See also

DHCP_SERVER_CONFIG_INFO_V6