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

TcEnumerateInterfaces

関数
トラフィック制御が利用可能なネットワークインターフェイスを列挙する。
DLLTRAFFIC.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD TcEnumerateInterfaces(
    HANDLE ClientHandle,
    DWORD* pBufferSize,
    TC_IFC_DESCRIPTOR* InterfaceBuffer
);

パラメーター

名前方向説明
ClientHandleHANDLEinTcRegisterClientで取得したクライアントハンドル。
pBufferSizeDWORD*inout入力でバッファのバイト数、出力で必要/使用バイト数を格納するポインタ。
InterfaceBufferTC_IFC_DESCRIPTOR*out列挙されたインターフェイス記述子を受け取るバッファへのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD TcEnumerateInterfaces(
    HANDLE ClientHandle,
    DWORD* pBufferSize,
    TC_IFC_DESCRIPTOR* InterfaceBuffer
);
[DllImport("TRAFFIC.dll", ExactSpelling = true)]
static extern uint TcEnumerateInterfaces(
    IntPtr ClientHandle,   // HANDLE
    ref uint pBufferSize,   // DWORD* in/out
    IntPtr InterfaceBuffer   // TC_IFC_DESCRIPTOR* out
);
<DllImport("TRAFFIC.dll", ExactSpelling:=True)>
Public Shared Function TcEnumerateInterfaces(
    ClientHandle As IntPtr,   ' HANDLE
    ByRef pBufferSize As UInteger,   ' DWORD* in/out
    InterfaceBuffer As IntPtr   ' TC_IFC_DESCRIPTOR* out
) As UInteger
End Function
' ClientHandle : HANDLE
' pBufferSize : DWORD* in/out
' InterfaceBuffer : TC_IFC_DESCRIPTOR* out
Declare PtrSafe Function TcEnumerateInterfaces Lib "traffic" ( _
    ByVal ClientHandle As LongPtr, _
    ByRef pBufferSize As Long, _
    ByVal InterfaceBuffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TcEnumerateInterfaces = ctypes.windll.traffic.TcEnumerateInterfaces
TcEnumerateInterfaces.restype = wintypes.DWORD
TcEnumerateInterfaces.argtypes = [
    wintypes.HANDLE,  # ClientHandle : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # pBufferSize : DWORD* in/out
    ctypes.c_void_p,  # InterfaceBuffer : TC_IFC_DESCRIPTOR* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	traffic = windows.NewLazySystemDLL("TRAFFIC.dll")
	procTcEnumerateInterfaces = traffic.NewProc("TcEnumerateInterfaces")
)

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

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

typedef TcEnumerateInterfacesNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
typedef TcEnumerateInterfacesDart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
final TcEnumerateInterfaces = DynamicLibrary.open('TRAFFIC.dll')
    .lookupFunction<TcEnumerateInterfacesNative, TcEnumerateInterfacesDart>('TcEnumerateInterfaces');
// ClientHandle : HANDLE -> Pointer<Void>
// pBufferSize : DWORD* in/out -> Pointer<Uint32>
// InterfaceBuffer : TC_IFC_DESCRIPTOR* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TcEnumerateInterfaces(
  ClientHandle: THandle;   // HANDLE
  pBufferSize: Pointer;   // DWORD* in/out
  InterfaceBuffer: Pointer   // TC_IFC_DESCRIPTOR* out
): DWORD; stdcall;
  external 'TRAFFIC.dll' name 'TcEnumerateInterfaces';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TcEnumerateInterfaces"
  c_TcEnumerateInterfaces :: Ptr () -> Ptr Word32 -> Ptr () -> IO Word32
-- ClientHandle : HANDLE -> Ptr ()
-- pBufferSize : DWORD* in/out -> Ptr Word32
-- InterfaceBuffer : TC_IFC_DESCRIPTOR* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let tcenumerateinterfaces =
  foreign "TcEnumerateInterfaces"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr void) @-> returning uint32_t)
(* ClientHandle : HANDLE -> (ptr void) *)
(* pBufferSize : DWORD* in/out -> (ptr uint32_t) *)
(* InterfaceBuffer : TC_IFC_DESCRIPTOR* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library traffic (t "TRAFFIC.dll"))
(cffi:use-foreign-library traffic)

(cffi:defcfun ("TcEnumerateInterfaces" tc-enumerate-interfaces :convention :stdcall) :uint32
  (client-handle :pointer)   ; HANDLE
  (p-buffer-size :pointer)   ; DWORD* in/out
  (interface-buffer :pointer))   ; TC_IFC_DESCRIPTOR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TcEnumerateInterfaces = Win32::API::More->new('TRAFFIC',
    'DWORD TcEnumerateInterfaces(HANDLE ClientHandle, LPVOID pBufferSize, LPVOID InterfaceBuffer)');
# my $ret = $TcEnumerateInterfaces->Call($ClientHandle, $pBufferSize, $InterfaceBuffer);
# ClientHandle : HANDLE -> HANDLE
# pBufferSize : DWORD* in/out -> LPVOID
# InterfaceBuffer : TC_IFC_DESCRIPTOR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型