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

TcEnumerateFlows

関数
インターフェイス上のトラフィック制御フローを列挙する。
DLLTRAFFIC.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD TcEnumerateFlows(
    HANDLE IfcHandle,
    HANDLE* pEnumHandle,
    DWORD* pFlowCount,
    DWORD* pBufSize,
    ENUMERATION_BUFFER* Buffer
);

パラメーター

名前方向説明
IfcHandleHANDLEinフローを列挙する対象のインターフェイスハンドル。
pEnumHandleHANDLE*inout列挙の継続位置を保持する列挙ハンドルへのポインタ。初回は0を指す。
pFlowCountDWORD*inout入力で取得希望フロー数、出力で実際の取得数を格納するポインタ。
pBufSizeDWORD*inout入力でBufferのバイト数、出力で必要/使用バイト数を格納するポインタ。
BufferENUMERATION_BUFFER*out列挙されたフロー情報を受け取るENUMERATION_BUFFER構造体へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

TcEnumerateFlows = ctypes.windll.traffic.TcEnumerateFlows
TcEnumerateFlows.restype = wintypes.DWORD
TcEnumerateFlows.argtypes = [
    wintypes.HANDLE,  # IfcHandle : HANDLE
    ctypes.c_void_p,  # pEnumHandle : HANDLE* in/out
    ctypes.POINTER(wintypes.DWORD),  # pFlowCount : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # pBufSize : DWORD* in/out
    ctypes.c_void_p,  # Buffer : ENUMERATION_BUFFER* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	traffic = windows.NewLazySystemDLL("TRAFFIC.dll")
	procTcEnumerateFlows = traffic.NewProc("TcEnumerateFlows")
)

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

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

typedef TcEnumerateFlowsNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Void>);
typedef TcEnumerateFlowsDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Void>);
final TcEnumerateFlows = DynamicLibrary.open('TRAFFIC.dll')
    .lookupFunction<TcEnumerateFlowsNative, TcEnumerateFlowsDart>('TcEnumerateFlows');
// IfcHandle : HANDLE -> Pointer<Void>
// pEnumHandle : HANDLE* in/out -> Pointer<Void>
// pFlowCount : DWORD* in/out -> Pointer<Uint32>
// pBufSize : DWORD* in/out -> Pointer<Uint32>
// Buffer : ENUMERATION_BUFFER* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TcEnumerateFlows(
  IfcHandle: THandle;   // HANDLE
  pEnumHandle: Pointer;   // HANDLE* in/out
  pFlowCount: Pointer;   // DWORD* in/out
  pBufSize: Pointer;   // DWORD* in/out
  Buffer: Pointer   // ENUMERATION_BUFFER* out
): DWORD; stdcall;
  external 'TRAFFIC.dll' name 'TcEnumerateFlows';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TcEnumerateFlows"
  c_TcEnumerateFlows :: Ptr () -> Ptr () -> Ptr Word32 -> Ptr Word32 -> Ptr () -> IO Word32
-- IfcHandle : HANDLE -> Ptr ()
-- pEnumHandle : HANDLE* in/out -> Ptr ()
-- pFlowCount : DWORD* in/out -> Ptr Word32
-- pBufSize : DWORD* in/out -> Ptr Word32
-- Buffer : ENUMERATION_BUFFER* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let tcenumerateflows =
  foreign "TcEnumerateFlows"
    ((ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr void) @-> returning uint32_t)
(* IfcHandle : HANDLE -> (ptr void) *)
(* pEnumHandle : HANDLE* in/out -> (ptr void) *)
(* pFlowCount : DWORD* in/out -> (ptr uint32_t) *)
(* pBufSize : DWORD* in/out -> (ptr uint32_t) *)
(* Buffer : ENUMERATION_BUFFER* 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 ("TcEnumerateFlows" tc-enumerate-flows :convention :stdcall) :uint32
  (ifc-handle :pointer)   ; HANDLE
  (p-enum-handle :pointer)   ; HANDLE* in/out
  (p-flow-count :pointer)   ; DWORD* in/out
  (p-buf-size :pointer)   ; DWORD* in/out
  (buffer :pointer))   ; ENUMERATION_BUFFER* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TcEnumerateFlows = Win32::API::More->new('TRAFFIC',
    'DWORD TcEnumerateFlows(HANDLE IfcHandle, HANDLE pEnumHandle, LPVOID pFlowCount, LPVOID pBufSize, LPVOID Buffer)');
# my $ret = $TcEnumerateFlows->Call($IfcHandle, $pEnumHandle, $pFlowCount, $pBufSize, $Buffer);
# IfcHandle : HANDLE -> HANDLE
# pEnumHandle : HANDLE* in/out -> HANDLE
# pFlowCount : DWORD* in/out -> LPVOID
# pBufSize : DWORD* in/out -> LPVOID
# Buffer : ENUMERATION_BUFFER* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型