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

TcRegisterClient

関数
トラフィック制御(TC)インターフェイスにクライアントを登録する。
DLLTRAFFIC.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD TcRegisterClient(
    DWORD TciVersion,
    HANDLE ClRegCtx,
    TCI_CLIENT_FUNC_LIST* ClientHandlerList,
    HANDLE* pClientHandle
);

パラメーター

名前方向説明
TciVersionDWORDin使用するTraffic Control(TCI)インターフェイスのバージョン番号。
ClRegCtxHANDLEinコールバックで返されるクライアント登録コンテキスト。
ClientHandlerListTCI_CLIENT_FUNC_LIST*in通知用コールバック関数群を格納したTCI_CLIENT_FUNC_LIST構造体へのポインタ。
pClientHandleHANDLE*out登録されたクライアントハンドルを受け取るポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

TcRegisterClient = ctypes.windll.traffic.TcRegisterClient
TcRegisterClient.restype = wintypes.DWORD
TcRegisterClient.argtypes = [
    wintypes.DWORD,  # TciVersion : DWORD
    wintypes.HANDLE,  # ClRegCtx : HANDLE
    ctypes.c_void_p,  # ClientHandlerList : TCI_CLIENT_FUNC_LIST*
    ctypes.c_void_p,  # pClientHandle : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	traffic = windows.NewLazySystemDLL("TRAFFIC.dll")
	procTcRegisterClient = traffic.NewProc("TcRegisterClient")
)

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

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

foreign import stdcall safe "TcRegisterClient"
  c_TcRegisterClient :: Word32 -> Ptr () -> Ptr () -> Ptr () -> IO Word32
-- TciVersion : DWORD -> Word32
-- ClRegCtx : HANDLE -> Ptr ()
-- ClientHandlerList : TCI_CLIENT_FUNC_LIST* -> Ptr ()
-- pClientHandle : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let tcregisterclient =
  foreign "TcRegisterClient"
    (uint32_t @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* TciVersion : DWORD -> uint32_t *)
(* ClRegCtx : HANDLE -> (ptr void) *)
(* ClientHandlerList : TCI_CLIENT_FUNC_LIST* -> (ptr void) *)
(* pClientHandle : 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 ("TcRegisterClient" tc-register-client :convention :stdcall) :uint32
  (tci-version :uint32)   ; DWORD
  (cl-reg-ctx :pointer)   ; HANDLE
  (client-handler-list :pointer)   ; TCI_CLIENT_FUNC_LIST*
  (p-client-handle :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TcRegisterClient = Win32::API::More->new('TRAFFIC',
    'DWORD TcRegisterClient(DWORD TciVersion, HANDLE ClRegCtx, LPVOID ClientHandlerList, HANDLE pClientHandle)');
# my $ret = $TcRegisterClient->Call($TciVersion, $ClRegCtx, $ClientHandlerList, $pClientHandle);
# TciVersion : DWORD -> DWORD
# ClRegCtx : HANDLE -> HANDLE
# ClientHandlerList : TCI_CLIENT_FUNC_LIST* -> LPVOID
# pClientHandle : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型