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

GetFriendlyIfIndex

関数
インターフェイス索引を扱いやすい簡略索引に変換する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetFriendlyIfIndex(
    DWORD IfIndex
);

パラメーター

名前方向説明
IfIndexDWORDin後方互換の「フレンドリ」インターフェイスインデックスの導出元となるインターフェイスインデックス。

戻り値の型: DWORD

公式ドキュメント

インターフェイスインデックスを受け取り、下位 24 ビットのみを使用する後方互換のインターフェイスインデックスを返します。

戻り値

下位 24 ビットのみを使用する後方互換のインターフェイスインデックス。

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

各言語での呼び出し定義

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

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

GetFriendlyIfIndex = ctypes.windll.iphlpapi.GetFriendlyIfIndex
GetFriendlyIfIndex.restype = wintypes.DWORD
GetFriendlyIfIndex.argtypes = [
    wintypes.DWORD,  # IfIndex : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetFriendlyIfIndex = Fiddle::Function.new(
  lib['GetFriendlyIfIndex'],
  [
    -Fiddle::TYPE_INT,  # IfIndex : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn GetFriendlyIfIndex(
        IfIndex: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetFriendlyIfIndex(uint IfIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetFriendlyIfIndex' -Namespace Win32 -PassThru
# $api::GetFriendlyIfIndex(IfIndex)
#uselib "IPHLPAPI.dll"
#func global GetFriendlyIfIndex "GetFriendlyIfIndex" sptr
; GetFriendlyIfIndex IfIndex   ; 戻り値は stat
; IfIndex : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IPHLPAPI.dll"
#cfunc global GetFriendlyIfIndex "GetFriendlyIfIndex" int
; res = GetFriendlyIfIndex(IfIndex)
; IfIndex : DWORD -> "int"
; DWORD GetFriendlyIfIndex(DWORD IfIndex)
#uselib "IPHLPAPI.dll"
#cfunc global GetFriendlyIfIndex "GetFriendlyIfIndex" int
; res = GetFriendlyIfIndex(IfIndex)
; IfIndex : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetFriendlyIfIndex = iphlpapi.NewProc("GetFriendlyIfIndex")
)

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

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

typedef GetFriendlyIfIndexNative = Uint32 Function(Uint32);
typedef GetFriendlyIfIndexDart = int Function(int);
final GetFriendlyIfIndex = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetFriendlyIfIndexNative, GetFriendlyIfIndexDart>('GetFriendlyIfIndex');
// IfIndex : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetFriendlyIfIndex(
  IfIndex: DWORD   // DWORD
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetFriendlyIfIndex';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetFriendlyIfIndex"
  c_GetFriendlyIfIndex :: Word32 -> IO Word32
-- IfIndex : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("GetFriendlyIfIndex" get-friendly-if-index :convention :stdcall) :uint32
  (if-index :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetFriendlyIfIndex = Win32::API::More->new('IPHLPAPI',
    'DWORD GetFriendlyIfIndex(DWORD IfIndex)');
# my $ret = $GetFriendlyIfIndex->Call($IfIndex);
# IfIndex : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目