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

GetNetworkConnectivityHintForInterface

関数
指定したインターフェイスのネットワーク接続性ヒントを取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

WIN32_ERROR GetNetworkConnectivityHintForInterface(
    DWORD InterfaceIndex,
    NL_NETWORK_CONNECTIVITY_HINT* ConnectivityHint
);

パラメーター

名前方向説明
InterfaceIndexDWORDin接続情報を取得する対象インターフェイスのインデックスを表す NET_IFINDEX 型の値。
ConnectivityHintNL_NETWORK_CONNECTIVITY_HINT*outNL_NETWORK_CONNECTIVITY_HINT 型の値へのポインター。この関数は、指定したインターフェイスの接続レベルおよびコストのヒントをこの値に設定します。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定したインターフェイスのネットワーク接続のレベルとコストを取得します。

戻り値

ユーザーモードでは、成功時に NO_ERROR を、失敗時に Win32 エラーコードを返します。カーネルモードでは、成功時に STATUS_SUCCESS を、失敗時に NTSTATUS エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetNetworkConnectivityHintForInterface(
    DWORD InterfaceIndex,
    NL_NETWORK_CONNECTIVITY_HINT* ConnectivityHint
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetNetworkConnectivityHintForInterface(
    uint InterfaceIndex,   // DWORD
    IntPtr ConnectivityHint   // NL_NETWORK_CONNECTIVITY_HINT* out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetNetworkConnectivityHintForInterface(
    InterfaceIndex As UInteger,   ' DWORD
    ConnectivityHint As IntPtr   ' NL_NETWORK_CONNECTIVITY_HINT* out
) As UInteger
End Function
' InterfaceIndex : DWORD
' ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out
Declare PtrSafe Function GetNetworkConnectivityHintForInterface Lib "iphlpapi" ( _
    ByVal InterfaceIndex As Long, _
    ByVal ConnectivityHint As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetNetworkConnectivityHintForInterface = ctypes.windll.iphlpapi.GetNetworkConnectivityHintForInterface
GetNetworkConnectivityHintForInterface.restype = wintypes.DWORD
GetNetworkConnectivityHintForInterface.argtypes = [
    wintypes.DWORD,  # InterfaceIndex : DWORD
    ctypes.c_void_p,  # ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetNetworkConnectivityHintForInterface = Fiddle::Function.new(
  lib['GetNetworkConnectivityHintForInterface'],
  [
    -Fiddle::TYPE_INT,  # InterfaceIndex : DWORD
    Fiddle::TYPE_VOIDP,  # ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn GetNetworkConnectivityHintForInterface(
        InterfaceIndex: u32,  // DWORD
        ConnectivityHint: *mut NL_NETWORK_CONNECTIVITY_HINT  // NL_NETWORK_CONNECTIVITY_HINT* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetNetworkConnectivityHintForInterface(uint InterfaceIndex, IntPtr ConnectivityHint);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetNetworkConnectivityHintForInterface' -Namespace Win32 -PassThru
# $api::GetNetworkConnectivityHintForInterface(InterfaceIndex, ConnectivityHint)
#uselib "IPHLPAPI.dll"
#func global GetNetworkConnectivityHintForInterface "GetNetworkConnectivityHintForInterface" sptr, sptr
; GetNetworkConnectivityHintForInterface InterfaceIndex, varptr(ConnectivityHint)   ; 戻り値は stat
; InterfaceIndex : DWORD -> "sptr"
; ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IPHLPAPI.dll"
#cfunc global GetNetworkConnectivityHintForInterface "GetNetworkConnectivityHintForInterface" int, var
; res = GetNetworkConnectivityHintForInterface(InterfaceIndex, ConnectivityHint)
; InterfaceIndex : DWORD -> "int"
; ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR GetNetworkConnectivityHintForInterface(DWORD InterfaceIndex, NL_NETWORK_CONNECTIVITY_HINT* ConnectivityHint)
#uselib "IPHLPAPI.dll"
#cfunc global GetNetworkConnectivityHintForInterface "GetNetworkConnectivityHintForInterface" int, var
; res = GetNetworkConnectivityHintForInterface(InterfaceIndex, ConnectivityHint)
; InterfaceIndex : DWORD -> "int"
; ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetNetworkConnectivityHintForInterface = iphlpapi.NewProc("GetNetworkConnectivityHintForInterface")
)

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

extern "iphlpapi" fn GetNetworkConnectivityHintForInterface(
    InterfaceIndex: u32, // DWORD
    ConnectivityHint: [*c]NL_NETWORK_CONNECTIVITY_HINT // NL_NETWORK_CONNECTIVITY_HINT* out
) callconv(std.os.windows.WINAPI) u32;
proc GetNetworkConnectivityHintForInterface(
    InterfaceIndex: uint32,  # DWORD
    ConnectivityHint: ptr NL_NETWORK_CONNECTIVITY_HINT  # NL_NETWORK_CONNECTIVITY_HINT* out
): uint32 {.importc: "GetNetworkConnectivityHintForInterface", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint GetNetworkConnectivityHintForInterface(
    uint InterfaceIndex,   // DWORD
    NL_NETWORK_CONNECTIVITY_HINT* ConnectivityHint   // NL_NETWORK_CONNECTIVITY_HINT* out
);
ccall((:GetNetworkConnectivityHintForInterface, "IPHLPAPI.dll"), stdcall, UInt32,
      (UInt32, Ptr{NL_NETWORK_CONNECTIVITY_HINT}),
      InterfaceIndex, ConnectivityHint)
# InterfaceIndex : DWORD -> UInt32
# ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out -> Ptr{NL_NETWORK_CONNECTIVITY_HINT}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetNetworkConnectivityHintForInterface(
    uint32_t InterfaceIndex,
    void* ConnectivityHint);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetNetworkConnectivityHintForInterface(InterfaceIndex, ConnectivityHint)
-- InterfaceIndex : DWORD
-- ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetNetworkConnectivityHintForInterface = lib.func('__stdcall', 'GetNetworkConnectivityHintForInterface', 'uint32_t', ['uint32_t', 'void *']);
// GetNetworkConnectivityHintForInterface(InterfaceIndex, ConnectivityHint)
// InterfaceIndex : DWORD -> 'uint32_t'
// ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  GetNetworkConnectivityHintForInterface: { parameters: ["u32", "pointer"], result: "u32" },
});
// lib.symbols.GetNetworkConnectivityHintForInterface(InterfaceIndex, ConnectivityHint)
// InterfaceIndex : DWORD -> "u32"
// ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetNetworkConnectivityHintForInterface(
    uint32_t InterfaceIndex,
    void* ConnectivityHint);
C, "IPHLPAPI.dll");
// $ffi->GetNetworkConnectivityHintForInterface(InterfaceIndex, ConnectivityHint);
// InterfaceIndex : DWORD
// ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out
// 構造体/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 GetNetworkConnectivityHintForInterface(
        int InterfaceIndex,   // DWORD
        Pointer ConnectivityHint   // NL_NETWORK_CONNECTIVITY_HINT* out
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun GetNetworkConnectivityHintForInterface = GetNetworkConnectivityHintForInterface(
    InterfaceIndex : UInt32,   # DWORD
    ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT*   # NL_NETWORK_CONNECTIVITY_HINT* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetNetworkConnectivityHintForInterfaceNative = Uint32 Function(Uint32, Pointer<Void>);
typedef GetNetworkConnectivityHintForInterfaceDart = int Function(int, Pointer<Void>);
final GetNetworkConnectivityHintForInterface = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetNetworkConnectivityHintForInterfaceNative, GetNetworkConnectivityHintForInterfaceDart>('GetNetworkConnectivityHintForInterface');
// InterfaceIndex : DWORD -> Uint32
// ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetNetworkConnectivityHintForInterface(
  InterfaceIndex: DWORD;   // DWORD
  ConnectivityHint: Pointer   // NL_NETWORK_CONNECTIVITY_HINT* out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetNetworkConnectivityHintForInterface';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetNetworkConnectivityHintForInterface"
  c_GetNetworkConnectivityHintForInterface :: Word32 -> Ptr () -> IO Word32
-- InterfaceIndex : DWORD -> Word32
-- ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getnetworkconnectivityhintforinterface =
  foreign "GetNetworkConnectivityHintForInterface"
    (uint32_t @-> (ptr void) @-> returning uint32_t)
(* InterfaceIndex : DWORD -> uint32_t *)
(* ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("GetNetworkConnectivityHintForInterface" get-network-connectivity-hint-for-interface :convention :stdcall) :uint32
  (interface-index :uint32)   ; DWORD
  (connectivity-hint :pointer))   ; NL_NETWORK_CONNECTIVITY_HINT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetNetworkConnectivityHintForInterface = Win32::API::More->new('IPHLPAPI',
    'DWORD GetNetworkConnectivityHintForInterface(DWORD InterfaceIndex, LPVOID ConnectivityHint)');
# my $ret = $GetNetworkConnectivityHintForInterface->Call($InterfaceIndex, $ConnectivityHint);
# InterfaceIndex : DWORD -> DWORD
# ConnectivityHint : NL_NETWORK_CONNECTIVITY_HINT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型