Win32 API 日本語リファレンス
ホームNetworkManagement.IpHelper › SetInterfaceDnsSettings

SetInterfaceDnsSettings

関数
指定したインターフェイスのDNS設定を構成する。
DLLIPHLPAPI.dll呼出規約winapi

シグネチャ

// IPHLPAPI.dll
#include <windows.h>

WIN32_ERROR SetInterfaceDnsSettings(
    GUID Interface,
    const DNS_INTERFACE_SETTINGS* Settings
);

パラメーター

名前方向説明
InterfaceGUIDin設定が参照する COM インターフェイスの GUID です。
SettingsDNS_INTERFACE_SETTINGS*in

DNS インターフェイス設定を格納する DNS_INTERFACE_SETTINGS 型の構造体へのポインターです。

このパラメーターが DNS_INTERFACE_SETTINGS 構造体を指す場合は、DNS_INTERFACE_SETTINGS::Version メンバーに DNS_INTERFACE_SETTINGS_VERSION1 を設定する必要があります。

このパラメーターが DNS_INTERFACE_SETTINGS_EX 構造体を指す場合は、バージョンに DNS_INTERFACE_SETTINGS_VERSION2 を設定する必要があります。

このパラメーターが DNS_INTERFACE_SETTINGS3 構造体を指す場合は、バージョンに DNS_INTERFACE_SETTINGS_VERSION3 を設定する必要があります。

DNS_INTERFACE_SETTINGS::Flags フィールドで必要なオプションをすべて適切に設定し、オプションを設定したフィールドのみを設定してください。対応するオプションがないその他のフィールドはすべてゼロクリアする必要があります。

戻り値の型: WIN32_ERROR

公式ドキュメント

Settings パラメーターで指定された、インターフェイスごとの DNS 設定を設定します。

戻り値

成功した場合は NO_ERROR を返します。0 以外の戻り値は失敗を示します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// IPHLPAPI.dll
#include <windows.h>

WIN32_ERROR SetInterfaceDnsSettings(
    GUID Interface,
    const DNS_INTERFACE_SETTINGS* Settings
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint SetInterfaceDnsSettings(
    Guid Interface,   // GUID
    IntPtr Settings   // DNS_INTERFACE_SETTINGS*
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function SetInterfaceDnsSettings(
    [Interface] As Guid,   ' GUID
    Settings As IntPtr   ' DNS_INTERFACE_SETTINGS*
) As UInteger
End Function
' Interface : GUID
' Settings : DNS_INTERFACE_SETTINGS*
Declare PtrSafe Function SetInterfaceDnsSettings Lib "iphlpapi" ( _
    ByVal Interface As LongPtr, _
    ByVal Settings As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetInterfaceDnsSettings = ctypes.windll.iphlpapi.SetInterfaceDnsSettings
SetInterfaceDnsSettings.restype = wintypes.DWORD
SetInterfaceDnsSettings.argtypes = [
    ctypes.c_void_p,  # Interface : GUID
    ctypes.c_void_p,  # Settings : DNS_INTERFACE_SETTINGS*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
SetInterfaceDnsSettings = Fiddle::Function.new(
  lib['SetInterfaceDnsSettings'],
  [
    Fiddle::TYPE_VOIDP,  # Interface : GUID
    Fiddle::TYPE_VOIDP,  # Settings : DNS_INTERFACE_SETTINGS*
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn SetInterfaceDnsSettings(
        Interface: GUID,  // GUID
        Settings: *const DNS_INTERFACE_SETTINGS  // DNS_INTERFACE_SETTINGS*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint SetInterfaceDnsSettings(Guid Interface, IntPtr Settings);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_SetInterfaceDnsSettings' -Namespace Win32 -PassThru
# $api::SetInterfaceDnsSettings(Interface, Settings)
#uselib "IPHLPAPI.dll"
#func global SetInterfaceDnsSettings "SetInterfaceDnsSettings" sptr, sptr
; SetInterfaceDnsSettings Interface, varptr(Settings)   ; 戻り値は stat
; Interface : GUID -> "sptr"
; Settings : DNS_INTERFACE_SETTINGS* -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IPHLPAPI.dll"
#cfunc global SetInterfaceDnsSettings "SetInterfaceDnsSettings" int, var
; res = SetInterfaceDnsSettings(Interface, Settings)
; Interface : GUID -> "int"
; Settings : DNS_INTERFACE_SETTINGS* -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR SetInterfaceDnsSettings(GUID Interface, DNS_INTERFACE_SETTINGS* Settings)
#uselib "IPHLPAPI.dll"
#cfunc global SetInterfaceDnsSettings "SetInterfaceDnsSettings" int, var
; res = SetInterfaceDnsSettings(Interface, Settings)
; Interface : GUID -> "int"
; Settings : DNS_INTERFACE_SETTINGS* -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procSetInterfaceDnsSettings = iphlpapi.NewProc("SetInterfaceDnsSettings")
)

// Interface (GUID), Settings (DNS_INTERFACE_SETTINGS*)
r1, _, err := procSetInterfaceDnsSettings.Call(
	uintptr(Interface),
	uintptr(Settings),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function SetInterfaceDnsSettings(
  Interface: TGUID;   // GUID
  Settings: Pointer   // DNS_INTERFACE_SETTINGS*
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'SetInterfaceDnsSettings';
result := DllCall("IPHLPAPI\SetInterfaceDnsSettings"
    , "Ptr", Interface   ; GUID
    , "Ptr", Settings   ; DNS_INTERFACE_SETTINGS*
    , "UInt")   ; return: WIN32_ERROR
●SetInterfaceDnsSettings(Interface, Settings) = DLL("IPHLPAPI.dll", "dword SetInterfaceDnsSettings(void*, void*)")
# 呼び出し: SetInterfaceDnsSettings(Interface, Settings)
# Interface : GUID -> "void*"
# Settings : DNS_INTERFACE_SETTINGS* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn SetInterfaceDnsSettings(
    Interface: GUID, // GUID
    Settings: [*c]DNS_INTERFACE_SETTINGS // DNS_INTERFACE_SETTINGS*
) callconv(std.os.windows.WINAPI) u32;
proc SetInterfaceDnsSettings(
    Interface: GUID,  # GUID
    Settings: ptr DNS_INTERFACE_SETTINGS  # DNS_INTERFACE_SETTINGS*
): uint32 {.importc: "SetInterfaceDnsSettings", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint SetInterfaceDnsSettings(
    GUID Interface,   // GUID
    DNS_INTERFACE_SETTINGS* Settings   // DNS_INTERFACE_SETTINGS*
);
ccall((:SetInterfaceDnsSettings, "IPHLPAPI.dll"), stdcall, UInt32,
      (GUID, Ptr{DNS_INTERFACE_SETTINGS}),
      Interface, Settings)
# Interface : GUID -> GUID
# Settings : DNS_INTERFACE_SETTINGS* -> Ptr{DNS_INTERFACE_SETTINGS}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SetInterfaceDnsSettings(
    GUID Interface,
    void* Settings);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.SetInterfaceDnsSettings(Interface, Settings)
-- Interface : GUID
-- Settings : DNS_INTERFACE_SETTINGS*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const SetInterfaceDnsSettings = lib.func('__stdcall', 'SetInterfaceDnsSettings', 'uint32_t', ['void *', 'void *']);
// SetInterfaceDnsSettings(Interface, Settings)
// Interface : GUID -> 'void *'
// Settings : DNS_INTERFACE_SETTINGS* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  SetInterfaceDnsSettings: { parameters: ["pointer", "pointer"], result: "u32" },
});
// lib.symbols.SetInterfaceDnsSettings(Interface, Settings)
// Interface : GUID -> "pointer"
// Settings : DNS_INTERFACE_SETTINGS* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SetInterfaceDnsSettings(
    GUID Interface,
    void* Settings);
C, "IPHLPAPI.dll");
// $ffi->SetInterfaceDnsSettings(Interface, Settings);
// Interface : GUID
// Settings : DNS_INTERFACE_SETTINGS*
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Iphlpapi extends StdCallLibrary {
    Iphlpapi INSTANCE = Native.load("iphlpapi", Iphlpapi.class);
    int SetInterfaceDnsSettings(
        Pointer Interface,   // GUID
        Pointer Settings   // DNS_INTERFACE_SETTINGS*
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun SetInterfaceDnsSettings = SetInterfaceDnsSettings(
    Interface : GUID,   # GUID
    Settings : DNS_INTERFACE_SETTINGS*   # DNS_INTERFACE_SETTINGS*
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetInterfaceDnsSettingsNative = Uint32 Function(Pointer<Void>, Pointer<Void>);
typedef SetInterfaceDnsSettingsDart = int Function(Pointer<Void>, Pointer<Void>);
final SetInterfaceDnsSettings = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<SetInterfaceDnsSettingsNative, SetInterfaceDnsSettingsDart>('SetInterfaceDnsSettings');
// Interface : GUID -> Pointer<Void>
// Settings : DNS_INTERFACE_SETTINGS* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetInterfaceDnsSettings(
  Interface: TGUID;   // GUID
  Settings: Pointer   // DNS_INTERFACE_SETTINGS*
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'SetInterfaceDnsSettings';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetInterfaceDnsSettings"
  c_SetInterfaceDnsSettings :: Ptr () -> Ptr () -> IO Word32
-- Interface : GUID -> Ptr ()
-- Settings : DNS_INTERFACE_SETTINGS* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let setinterfacednssettings =
  foreign "SetInterfaceDnsSettings"
    ((ptr void) @-> (ptr void) @-> returning uint32_t)
(* Interface : GUID -> (ptr void) *)
(* Settings : DNS_INTERFACE_SETTINGS* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("SetInterfaceDnsSettings" set-interface-dns-settings :convention :stdcall) :uint32
  (interface :pointer)   ; GUID
  (settings :pointer))   ; DNS_INTERFACE_SETTINGS*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetInterfaceDnsSettings = Win32::API::More->new('IPHLPAPI',
    'DWORD SetInterfaceDnsSettings(LPVOID Interface, LPVOID Settings)');
# my $ret = $SetInterfaceDnsSettings->Call($Interface, $Settings);
# Interface : GUID -> LPVOID
# Settings : DNS_INTERFACE_SETTINGS* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型