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

TcOpenInterfaceW

関数
指定名のトラフィック制御インターフェイスを開く(Unicode版)。
DLLTRAFFIC.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// TRAFFIC.dll  (Unicode / -W)
#include <windows.h>

DWORD TcOpenInterfaceW(
    LPWSTR pInterfaceName,
    HANDLE ClientHandle,
    HANDLE ClIfcCtx,
    HANDLE* pIfcHandle
);

パラメーター

名前方向説明
pInterfaceNameLPWSTRin開く対象のインターフェイス名を指すワイド文字列。
ClientHandleHANDLEinTcRegisterClientで取得したクライアントハンドル。
ClIfcCtxHANDLEin通知時に返されるインターフェイス単位のクライアントコンテキスト。
pIfcHandleHANDLE*out開いたインターフェイスのハンドルを受け取るポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

// TRAFFIC.dll  (Unicode / -W)
#include <windows.h>

DWORD TcOpenInterfaceW(
    LPWSTR pInterfaceName,
    HANDLE ClientHandle,
    HANDLE ClIfcCtx,
    HANDLE* pIfcHandle
);
[DllImport("TRAFFIC.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint TcOpenInterfaceW(
    [MarshalAs(UnmanagedType.LPWStr)] string pInterfaceName,   // LPWSTR
    IntPtr ClientHandle,   // HANDLE
    IntPtr ClIfcCtx,   // HANDLE
    IntPtr pIfcHandle   // HANDLE* out
);
<DllImport("TRAFFIC.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function TcOpenInterfaceW(
    <MarshalAs(UnmanagedType.LPWStr)> pInterfaceName As String,   ' LPWSTR
    ClientHandle As IntPtr,   ' HANDLE
    ClIfcCtx As IntPtr,   ' HANDLE
    pIfcHandle As IntPtr   ' HANDLE* out
) As UInteger
End Function
' pInterfaceName : LPWSTR
' ClientHandle : HANDLE
' ClIfcCtx : HANDLE
' pIfcHandle : HANDLE* out
Declare PtrSafe Function TcOpenInterfaceW Lib "traffic" ( _
    ByVal pInterfaceName As LongPtr, _
    ByVal ClientHandle As LongPtr, _
    ByVal ClIfcCtx As LongPtr, _
    ByVal pIfcHandle As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TcOpenInterfaceW = ctypes.windll.traffic.TcOpenInterfaceW
TcOpenInterfaceW.restype = wintypes.DWORD
TcOpenInterfaceW.argtypes = [
    wintypes.LPCWSTR,  # pInterfaceName : LPWSTR
    wintypes.HANDLE,  # ClientHandle : HANDLE
    wintypes.HANDLE,  # ClIfcCtx : HANDLE
    ctypes.c_void_p,  # pIfcHandle : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TRAFFIC.dll')
TcOpenInterfaceW = Fiddle::Function.new(
  lib['TcOpenInterfaceW'],
  [
    Fiddle::TYPE_VOIDP,  # pInterfaceName : LPWSTR
    Fiddle::TYPE_VOIDP,  # ClientHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # ClIfcCtx : HANDLE
    Fiddle::TYPE_VOIDP,  # pIfcHandle : HANDLE* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "traffic")]
extern "system" {
    fn TcOpenInterfaceW(
        pInterfaceName: *mut u16,  // LPWSTR
        ClientHandle: *mut core::ffi::c_void,  // HANDLE
        ClIfcCtx: *mut core::ffi::c_void,  // HANDLE
        pIfcHandle: *mut *mut core::ffi::c_void  // HANDLE* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("TRAFFIC.dll", CharSet = CharSet.Unicode)]
public static extern uint TcOpenInterfaceW([MarshalAs(UnmanagedType.LPWStr)] string pInterfaceName, IntPtr ClientHandle, IntPtr ClIfcCtx, IntPtr pIfcHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TRAFFIC_TcOpenInterfaceW' -Namespace Win32 -PassThru
# $api::TcOpenInterfaceW(pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle)
#uselib "TRAFFIC.dll"
#func global TcOpenInterfaceW "TcOpenInterfaceW" wptr, wptr, wptr, wptr
; TcOpenInterfaceW pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle   ; 戻り値は stat
; pInterfaceName : LPWSTR -> "wptr"
; ClientHandle : HANDLE -> "wptr"
; ClIfcCtx : HANDLE -> "wptr"
; pIfcHandle : HANDLE* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "TRAFFIC.dll"
#cfunc global TcOpenInterfaceW "TcOpenInterfaceW" wstr, sptr, sptr, sptr
; res = TcOpenInterfaceW(pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle)
; pInterfaceName : LPWSTR -> "wstr"
; ClientHandle : HANDLE -> "sptr"
; ClIfcCtx : HANDLE -> "sptr"
; pIfcHandle : HANDLE* out -> "sptr"
; DWORD TcOpenInterfaceW(LPWSTR pInterfaceName, HANDLE ClientHandle, HANDLE ClIfcCtx, HANDLE* pIfcHandle)
#uselib "TRAFFIC.dll"
#cfunc global TcOpenInterfaceW "TcOpenInterfaceW" wstr, intptr, intptr, intptr
; res = TcOpenInterfaceW(pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle)
; pInterfaceName : LPWSTR -> "wstr"
; ClientHandle : HANDLE -> "intptr"
; ClIfcCtx : HANDLE -> "intptr"
; pIfcHandle : HANDLE* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	traffic = windows.NewLazySystemDLL("TRAFFIC.dll")
	procTcOpenInterfaceW = traffic.NewProc("TcOpenInterfaceW")
)

// pInterfaceName (LPWSTR), ClientHandle (HANDLE), ClIfcCtx (HANDLE), pIfcHandle (HANDLE* out)
r1, _, err := procTcOpenInterfaceW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pInterfaceName))),
	uintptr(ClientHandle),
	uintptr(ClIfcCtx),
	uintptr(pIfcHandle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function TcOpenInterfaceW(
  pInterfaceName: PWideChar;   // LPWSTR
  ClientHandle: THandle;   // HANDLE
  ClIfcCtx: THandle;   // HANDLE
  pIfcHandle: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'TRAFFIC.dll' name 'TcOpenInterfaceW';
result := DllCall("TRAFFIC\TcOpenInterfaceW"
    , "WStr", pInterfaceName   ; LPWSTR
    , "Ptr", ClientHandle   ; HANDLE
    , "Ptr", ClIfcCtx   ; HANDLE
    , "Ptr", pIfcHandle   ; HANDLE* out
    , "UInt")   ; return: DWORD
●TcOpenInterfaceW(pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle) = DLL("TRAFFIC.dll", "dword TcOpenInterfaceW(char*, void*, void*, void*)")
# 呼び出し: TcOpenInterfaceW(pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle)
# pInterfaceName : LPWSTR -> "char*"
# ClientHandle : HANDLE -> "void*"
# ClIfcCtx : HANDLE -> "void*"
# pIfcHandle : HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "traffic" fn TcOpenInterfaceW(
    pInterfaceName: [*c]const u16, // LPWSTR
    ClientHandle: ?*anyopaque, // HANDLE
    ClIfcCtx: ?*anyopaque, // HANDLE
    pIfcHandle: ?*anyopaque // HANDLE* out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc TcOpenInterfaceW(
    pInterfaceName: WideCString,  # LPWSTR
    ClientHandle: pointer,  # HANDLE
    ClIfcCtx: pointer,  # HANDLE
    pIfcHandle: pointer  # HANDLE* out
): uint32 {.importc: "TcOpenInterfaceW", stdcall, dynlib: "TRAFFIC.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "traffic");
extern(Windows)
uint TcOpenInterfaceW(
    const(wchar)* pInterfaceName,   // LPWSTR
    void* ClientHandle,   // HANDLE
    void* ClIfcCtx,   // HANDLE
    void* pIfcHandle   // HANDLE* out
);
ccall((:TcOpenInterfaceW, "TRAFFIC.dll"), stdcall, UInt32,
      (Cwstring, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}),
      pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle)
# pInterfaceName : LPWSTR -> Cwstring
# ClientHandle : HANDLE -> Ptr{Cvoid}
# ClIfcCtx : HANDLE -> Ptr{Cvoid}
# pIfcHandle : HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t TcOpenInterfaceW(
    const uint16_t* pInterfaceName,
    void* ClientHandle,
    void* ClIfcCtx,
    void* pIfcHandle);
]]
local traffic = ffi.load("traffic")
-- traffic.TcOpenInterfaceW(pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle)
-- pInterfaceName : LPWSTR
-- ClientHandle : HANDLE
-- ClIfcCtx : HANDLE
-- pIfcHandle : HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('TRAFFIC.dll');
const TcOpenInterfaceW = lib.func('__stdcall', 'TcOpenInterfaceW', 'uint32_t', ['str16', 'void *', 'void *', 'void *']);
// TcOpenInterfaceW(pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle)
// pInterfaceName : LPWSTR -> 'str16'
// ClientHandle : HANDLE -> 'void *'
// ClIfcCtx : HANDLE -> 'void *'
// pIfcHandle : HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("TRAFFIC.dll", {
  TcOpenInterfaceW: { parameters: ["buffer", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.TcOpenInterfaceW(pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle)
// pInterfaceName : LPWSTR -> "buffer"
// ClientHandle : HANDLE -> "pointer"
// ClIfcCtx : HANDLE -> "pointer"
// pIfcHandle : HANDLE* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t TcOpenInterfaceW(
    const uint16_t* pInterfaceName,
    void* ClientHandle,
    void* ClIfcCtx,
    void* pIfcHandle);
C, "TRAFFIC.dll");
// $ffi->TcOpenInterfaceW(pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle);
// pInterfaceName : LPWSTR
// ClientHandle : HANDLE
// ClIfcCtx : HANDLE
// pIfcHandle : 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, W32APIOptions.UNICODE_OPTIONS);
    int TcOpenInterfaceW(
        WString pInterfaceName,   // LPWSTR
        Pointer ClientHandle,   // HANDLE
        Pointer ClIfcCtx,   // HANDLE
        Pointer pIfcHandle   // HANDLE* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("traffic")]
lib LibTRAFFIC
  fun TcOpenInterfaceW = TcOpenInterfaceW(
    pInterfaceName : UInt16*,   # LPWSTR
    ClientHandle : Void*,   # HANDLE
    ClIfcCtx : Void*,   # HANDLE
    pIfcHandle : 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 TcOpenInterfaceWNative = Uint32 Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef TcOpenInterfaceWDart = int Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final TcOpenInterfaceW = DynamicLibrary.open('TRAFFIC.dll')
    .lookupFunction<TcOpenInterfaceWNative, TcOpenInterfaceWDart>('TcOpenInterfaceW');
// pInterfaceName : LPWSTR -> Pointer<Utf16>
// ClientHandle : HANDLE -> Pointer<Void>
// ClIfcCtx : HANDLE -> Pointer<Void>
// pIfcHandle : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TcOpenInterfaceW(
  pInterfaceName: PWideChar;   // LPWSTR
  ClientHandle: THandle;   // HANDLE
  ClIfcCtx: THandle;   // HANDLE
  pIfcHandle: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'TRAFFIC.dll' name 'TcOpenInterfaceW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TcOpenInterfaceW"
  c_TcOpenInterfaceW :: CWString -> Ptr () -> Ptr () -> Ptr () -> IO Word32
-- pInterfaceName : LPWSTR -> CWString
-- ClientHandle : HANDLE -> Ptr ()
-- ClIfcCtx : HANDLE -> Ptr ()
-- pIfcHandle : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let tcopeninterfacew =
  foreign "TcOpenInterfaceW"
    ((ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* pInterfaceName : LPWSTR -> (ptr uint16_t) *)
(* ClientHandle : HANDLE -> (ptr void) *)
(* ClIfcCtx : HANDLE -> (ptr void) *)
(* pIfcHandle : 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 ("TcOpenInterfaceW" tc-open-interface-w :convention :stdcall) :uint32
  (p-interface-name (:string :encoding :utf-16le))   ; LPWSTR
  (client-handle :pointer)   ; HANDLE
  (cl-ifc-ctx :pointer)   ; HANDLE
  (p-ifc-handle :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TcOpenInterfaceW = Win32::API::More->new('TRAFFIC',
    'DWORD TcOpenInterfaceW(LPCWSTR pInterfaceName, HANDLE ClientHandle, HANDLE ClIfcCtx, HANDLE pIfcHandle)');
# my $ret = $TcOpenInterfaceW->Call($pInterfaceName, $ClientHandle, $ClIfcCtx, $pIfcHandle);
# pInterfaceName : LPWSTR -> LPCWSTR
# ClientHandle : HANDLE -> HANDLE
# ClIfcCtx : HANDLE -> HANDLE
# pIfcHandle : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い