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

TcAddFilter

関数
フローにトラフィックを振り分けるフィルターを追加する。
DLLTRAFFIC.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD TcAddFilter(
    HANDLE FlowHandle,
    TC_GEN_FILTER* pGenericFilter,
    HANDLE* pFilterHandle
);

パラメーター

名前方向説明
FlowHandleHANDLEinフィルタを関連付ける対象のフローハンドル。
pGenericFilterTC_GEN_FILTER*in追加するフィルタ条件を格納したTC_GEN_FILTER構造体へのポインタ。
pFilterHandleHANDLE*out生成されたフィルタのハンドルを受け取るポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

TcAddFilter = ctypes.windll.traffic.TcAddFilter
TcAddFilter.restype = wintypes.DWORD
TcAddFilter.argtypes = [
    wintypes.HANDLE,  # FlowHandle : HANDLE
    ctypes.c_void_p,  # pGenericFilter : TC_GEN_FILTER*
    ctypes.c_void_p,  # pFilterHandle : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TRAFFIC.dll')
TcAddFilter = Fiddle::Function.new(
  lib['TcAddFilter'],
  [
    Fiddle::TYPE_VOIDP,  # FlowHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # pGenericFilter : TC_GEN_FILTER*
    Fiddle::TYPE_VOIDP,  # pFilterHandle : HANDLE* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "traffic")]
extern "system" {
    fn TcAddFilter(
        FlowHandle: *mut core::ffi::c_void,  // HANDLE
        pGenericFilter: *mut TC_GEN_FILTER,  // TC_GEN_FILTER*
        pFilterHandle: *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 TcAddFilter(IntPtr FlowHandle, IntPtr pGenericFilter, IntPtr pFilterHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TRAFFIC_TcAddFilter' -Namespace Win32 -PassThru
# $api::TcAddFilter(FlowHandle, pGenericFilter, pFilterHandle)
#uselib "TRAFFIC.dll"
#func global TcAddFilter "TcAddFilter" sptr, sptr, sptr
; TcAddFilter FlowHandle, varptr(pGenericFilter), pFilterHandle   ; 戻り値は stat
; FlowHandle : HANDLE -> "sptr"
; pGenericFilter : TC_GEN_FILTER* -> "sptr"
; pFilterHandle : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "TRAFFIC.dll"
#cfunc global TcAddFilter "TcAddFilter" sptr, var, sptr
; res = TcAddFilter(FlowHandle, pGenericFilter, pFilterHandle)
; FlowHandle : HANDLE -> "sptr"
; pGenericFilter : TC_GEN_FILTER* -> "var"
; pFilterHandle : HANDLE* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD TcAddFilter(HANDLE FlowHandle, TC_GEN_FILTER* pGenericFilter, HANDLE* pFilterHandle)
#uselib "TRAFFIC.dll"
#cfunc global TcAddFilter "TcAddFilter" intptr, var, intptr
; res = TcAddFilter(FlowHandle, pGenericFilter, pFilterHandle)
; FlowHandle : HANDLE -> "intptr"
; pGenericFilter : TC_GEN_FILTER* -> "var"
; pFilterHandle : HANDLE* out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	traffic = windows.NewLazySystemDLL("TRAFFIC.dll")
	procTcAddFilter = traffic.NewProc("TcAddFilter")
)

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

extern "traffic" fn TcAddFilter(
    FlowHandle: ?*anyopaque, // HANDLE
    pGenericFilter: [*c]TC_GEN_FILTER, // TC_GEN_FILTER*
    pFilterHandle: ?*anyopaque // HANDLE* out
) callconv(std.os.windows.WINAPI) u32;
proc TcAddFilter(
    FlowHandle: pointer,  # HANDLE
    pGenericFilter: ptr TC_GEN_FILTER,  # TC_GEN_FILTER*
    pFilterHandle: pointer  # HANDLE* out
): uint32 {.importc: "TcAddFilter", stdcall, dynlib: "TRAFFIC.dll".}
pragma(lib, "traffic");
extern(Windows)
uint TcAddFilter(
    void* FlowHandle,   // HANDLE
    TC_GEN_FILTER* pGenericFilter,   // TC_GEN_FILTER*
    void* pFilterHandle   // HANDLE* out
);
ccall((:TcAddFilter, "TRAFFIC.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{TC_GEN_FILTER}, Ptr{Cvoid}),
      FlowHandle, pGenericFilter, pFilterHandle)
# FlowHandle : HANDLE -> Ptr{Cvoid}
# pGenericFilter : TC_GEN_FILTER* -> Ptr{TC_GEN_FILTER}
# pFilterHandle : HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t TcAddFilter(
    void* FlowHandle,
    void* pGenericFilter,
    void* pFilterHandle);
]]
local traffic = ffi.load("traffic")
-- traffic.TcAddFilter(FlowHandle, pGenericFilter, pFilterHandle)
-- FlowHandle : HANDLE
-- pGenericFilter : TC_GEN_FILTER*
-- pFilterHandle : HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('TRAFFIC.dll');
const TcAddFilter = lib.func('__stdcall', 'TcAddFilter', 'uint32_t', ['void *', 'void *', 'void *']);
// TcAddFilter(FlowHandle, pGenericFilter, pFilterHandle)
// FlowHandle : HANDLE -> 'void *'
// pGenericFilter : TC_GEN_FILTER* -> 'void *'
// pFilterHandle : HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("TRAFFIC.dll", {
  TcAddFilter: { parameters: ["pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.TcAddFilter(FlowHandle, pGenericFilter, pFilterHandle)
// FlowHandle : HANDLE -> "pointer"
// pGenericFilter : TC_GEN_FILTER* -> "pointer"
// pFilterHandle : HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t TcAddFilter(
    void* FlowHandle,
    void* pGenericFilter,
    void* pFilterHandle);
C, "TRAFFIC.dll");
// $ffi->TcAddFilter(FlowHandle, pGenericFilter, pFilterHandle);
// FlowHandle : HANDLE
// pGenericFilter : TC_GEN_FILTER*
// pFilterHandle : 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 TcAddFilter(
        Pointer FlowHandle,   // HANDLE
        Pointer pGenericFilter,   // TC_GEN_FILTER*
        Pointer pFilterHandle   // HANDLE* out
    );
}
@[Link("traffic")]
lib LibTRAFFIC
  fun TcAddFilter = TcAddFilter(
    FlowHandle : Void*,   # HANDLE
    pGenericFilter : TC_GEN_FILTER*,   # TC_GEN_FILTER*
    pFilterHandle : 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 TcAddFilterNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef TcAddFilterDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final TcAddFilter = DynamicLibrary.open('TRAFFIC.dll')
    .lookupFunction<TcAddFilterNative, TcAddFilterDart>('TcAddFilter');
// FlowHandle : HANDLE -> Pointer<Void>
// pGenericFilter : TC_GEN_FILTER* -> Pointer<Void>
// pFilterHandle : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TcAddFilter(
  FlowHandle: THandle;   // HANDLE
  pGenericFilter: Pointer;   // TC_GEN_FILTER*
  pFilterHandle: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'TRAFFIC.dll' name 'TcAddFilter';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TcAddFilter"
  c_TcAddFilter :: Ptr () -> Ptr () -> Ptr () -> IO Word32
-- FlowHandle : HANDLE -> Ptr ()
-- pGenericFilter : TC_GEN_FILTER* -> Ptr ()
-- pFilterHandle : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

関連項目

使用する型