Edit

Share via

GetInterfaceDnsSettings function (netioapi.h)

  • Article

Retrieves the DNS settings from the interface specified in the Interface parameter. When you are done with the returned settings object, you must call FreeInterfaceDnsSettings to free it.

Syntax

NETIOAPI_API GetInterfaceDnsSettings(
  GUID                   Interface,
  DNS_INTERFACE_SETTINGS *Settings
);

Parameters

Interface

Type: _In_ GUID

The GUID of the COM interface that the settings refer to.

Settings

Type: _Inout_ const DNS_INTERFACE_SETTINGS*

GetInterfaceDnsSettings populates all the settings in this structure.

You should set only the Version member; the Flags field must be empty.

If you set the Version member to DNS_INTERFACE_SETTINGS_VERSION1, then the Settings parameter must point to a valid DNS_INTERFACE_SETTINGS structure.

If you set the Version member to DNS_INTERFACE_SETTINGS_VERSION2, then the Settings parameter must point to a valid DNS_INTERFACE_SETTINGS_EX structure.

If you set the Version member to DNS_INTERFACE_SETTINGS_VERSION3, then the Settings parameter must point to a valid DNS_INTERFACE_SETTINGS3 structure.

Return value

Returns NO_ERROR if successful. A non-zero return value indicates failure.

Requirements

Requirement Value
Minimum supported client Windows 10 Build 19041
Minimum supported server Windows 10 Build 19041
Target Platform Windows
Header netioapi.h (include Iphlpapi.h)
Library Iphlpapi.lib
DLL Iphlpapi.dll

See also