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

TcAddFlow

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

シグネチャ

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

DWORD TcAddFlow(
    HANDLE IfcHandle,
    HANDLE ClFlowCtx,
    DWORD Flags,
    TC_GEN_FLOW* pGenericFlow,
    HANDLE* pFlowHandle
);

パラメーター

名前方向説明
IfcHandleHANDLEinフローを追加する対象のインターフェイスハンドル。
ClFlowCtxHANDLEin通知時に返されるフロー単位のクライアントコンテキスト。
FlagsDWORDinフロー追加動作を制御するフラグ。通常は0を指定する。
pGenericFlowTC_GEN_FLOW*in追加するフローのパラメータを格納したTC_GEN_FLOW構造体へのポインタ。
pFlowHandleHANDLE*out生成されたフローのハンドルを受け取るポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

TcAddFlow = ctypes.windll.traffic.TcAddFlow
TcAddFlow.restype = wintypes.DWORD
TcAddFlow.argtypes = [
    wintypes.HANDLE,  # IfcHandle : HANDLE
    wintypes.HANDLE,  # ClFlowCtx : HANDLE
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_void_p,  # pGenericFlow : TC_GEN_FLOW*
    ctypes.c_void_p,  # pFlowHandle : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	traffic = windows.NewLazySystemDLL("TRAFFIC.dll")
	procTcAddFlow = traffic.NewProc("TcAddFlow")
)

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

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

typedef TcAddFlowNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>);
typedef TcAddFlowDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final TcAddFlow = DynamicLibrary.open('TRAFFIC.dll')
    .lookupFunction<TcAddFlowNative, TcAddFlowDart>('TcAddFlow');
// IfcHandle : HANDLE -> Pointer<Void>
// ClFlowCtx : HANDLE -> Pointer<Void>
// Flags : DWORD -> Uint32
// pGenericFlow : TC_GEN_FLOW* -> Pointer<Void>
// pFlowHandle : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TcAddFlow(
  IfcHandle: THandle;   // HANDLE
  ClFlowCtx: THandle;   // HANDLE
  Flags: DWORD;   // DWORD
  pGenericFlow: Pointer;   // TC_GEN_FLOW*
  pFlowHandle: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'TRAFFIC.dll' name 'TcAddFlow';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TcAddFlow"
  c_TcAddFlow :: Ptr () -> Ptr () -> Word32 -> Ptr () -> Ptr () -> IO Word32
-- IfcHandle : HANDLE -> Ptr ()
-- ClFlowCtx : HANDLE -> Ptr ()
-- Flags : DWORD -> Word32
-- pGenericFlow : TC_GEN_FLOW* -> Ptr ()
-- pFlowHandle : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let tcaddflow =
  foreign "TcAddFlow"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* IfcHandle : HANDLE -> (ptr void) *)
(* ClFlowCtx : HANDLE -> (ptr void) *)
(* Flags : DWORD -> uint32_t *)
(* pGenericFlow : TC_GEN_FLOW* -> (ptr void) *)
(* pFlowHandle : HANDLE* 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 ("TcAddFlow" tc-add-flow :convention :stdcall) :uint32
  (ifc-handle :pointer)   ; HANDLE
  (cl-flow-ctx :pointer)   ; HANDLE
  (flags :uint32)   ; DWORD
  (p-generic-flow :pointer)   ; TC_GEN_FLOW*
  (p-flow-handle :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TcAddFlow = Win32::API::More->new('TRAFFIC',
    'DWORD TcAddFlow(HANDLE IfcHandle, HANDLE ClFlowCtx, DWORD Flags, LPVOID pGenericFlow, HANDLE pFlowHandle)');
# my $ret = $TcAddFlow->Call($IfcHandle, $ClFlowCtx, $Flags, $pGenericFlow, $pFlowHandle);
# IfcHandle : HANDLE -> HANDLE
# ClFlowCtx : HANDLE -> HANDLE
# Flags : DWORD -> DWORD
# pGenericFlow : TC_GEN_FLOW* -> LPVOID
# pFlowHandle : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型