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

TcOpenInterfaceA

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

シグネチャ

// TRAFFIC.dll  (ANSI / -A)
#include <windows.h>

DWORD TcOpenInterfaceA(
    LPSTR pInterfaceName,
    HANDLE ClientHandle,
    HANDLE ClIfcCtx,
    HANDLE* pIfcHandle
);

パラメーター

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

戻り値の型: DWORD

各言語での呼び出し定義

// TRAFFIC.dll  (ANSI / -A)
#include <windows.h>

DWORD TcOpenInterfaceA(
    LPSTR pInterfaceName,
    HANDLE ClientHandle,
    HANDLE ClIfcCtx,
    HANDLE* pIfcHandle
);
[DllImport("TRAFFIC.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint TcOpenInterfaceA(
    [MarshalAs(UnmanagedType.LPStr)] string pInterfaceName,   // LPSTR
    IntPtr ClientHandle,   // HANDLE
    IntPtr ClIfcCtx,   // HANDLE
    IntPtr pIfcHandle   // HANDLE* out
);
<DllImport("TRAFFIC.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function TcOpenInterfaceA(
    <MarshalAs(UnmanagedType.LPStr)> pInterfaceName As String,   ' LPSTR
    ClientHandle As IntPtr,   ' HANDLE
    ClIfcCtx As IntPtr,   ' HANDLE
    pIfcHandle As IntPtr   ' HANDLE* out
) As UInteger
End Function
' pInterfaceName : LPSTR
' ClientHandle : HANDLE
' ClIfcCtx : HANDLE
' pIfcHandle : HANDLE* out
Declare PtrSafe Function TcOpenInterfaceA Lib "traffic" ( _
    ByVal pInterfaceName As String, _
    ByVal ClientHandle As LongPtr, _
    ByVal ClIfcCtx As LongPtr, _
    ByVal pIfcHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TcOpenInterfaceA = ctypes.windll.traffic.TcOpenInterfaceA
TcOpenInterfaceA.restype = wintypes.DWORD
TcOpenInterfaceA.argtypes = [
    wintypes.LPCSTR,  # pInterfaceName : LPSTR
    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')
TcOpenInterfaceA = Fiddle::Function.new(
  lib['TcOpenInterfaceA'],
  [
    Fiddle::TYPE_VOIDP,  # pInterfaceName : LPSTR
    Fiddle::TYPE_VOIDP,  # ClientHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # ClIfcCtx : HANDLE
    Fiddle::TYPE_VOIDP,  # pIfcHandle : HANDLE* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "traffic")]
extern "system" {
    fn TcOpenInterfaceA(
        pInterfaceName: *mut u8,  // LPSTR
        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.Ansi)]
public static extern uint TcOpenInterfaceA([MarshalAs(UnmanagedType.LPStr)] string pInterfaceName, IntPtr ClientHandle, IntPtr ClIfcCtx, IntPtr pIfcHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TRAFFIC_TcOpenInterfaceA' -Namespace Win32 -PassThru
# $api::TcOpenInterfaceA(pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle)
#uselib "TRAFFIC.dll"
#func global TcOpenInterfaceA "TcOpenInterfaceA" sptr, sptr, sptr, sptr
; TcOpenInterfaceA pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle   ; 戻り値は stat
; pInterfaceName : LPSTR -> "sptr"
; ClientHandle : HANDLE -> "sptr"
; ClIfcCtx : HANDLE -> "sptr"
; pIfcHandle : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "TRAFFIC.dll"
#cfunc global TcOpenInterfaceA "TcOpenInterfaceA" str, sptr, sptr, sptr
; res = TcOpenInterfaceA(pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle)
; pInterfaceName : LPSTR -> "str"
; ClientHandle : HANDLE -> "sptr"
; ClIfcCtx : HANDLE -> "sptr"
; pIfcHandle : HANDLE* out -> "sptr"
; DWORD TcOpenInterfaceA(LPSTR pInterfaceName, HANDLE ClientHandle, HANDLE ClIfcCtx, HANDLE* pIfcHandle)
#uselib "TRAFFIC.dll"
#cfunc global TcOpenInterfaceA "TcOpenInterfaceA" str, intptr, intptr, intptr
; res = TcOpenInterfaceA(pInterfaceName, ClientHandle, ClIfcCtx, pIfcHandle)
; pInterfaceName : LPSTR -> "str"
; ClientHandle : HANDLE -> "intptr"
; ClIfcCtx : HANDLE -> "intptr"
; pIfcHandle : HANDLE* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	traffic = windows.NewLazySystemDLL("TRAFFIC.dll")
	procTcOpenInterfaceA = traffic.NewProc("TcOpenInterfaceA")
)

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

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

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

let tcopeninterfacea =
  foreign "TcOpenInterfaceA"
    (string @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* pInterfaceName : LPSTR -> string *)
(* 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 ("TcOpenInterfaceA" tc-open-interface-a :convention :stdcall) :uint32
  (p-interface-name :string)   ; LPSTR
  (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 $TcOpenInterfaceA = Win32::API::More->new('TRAFFIC',
    'DWORD TcOpenInterfaceA(LPCSTR pInterfaceName, HANDLE ClientHandle, HANDLE ClIfcCtx, HANDLE pIfcHandle)');
# my $ret = $TcOpenInterfaceA->Call($pInterfaceName, $ClientHandle, $ClIfcCtx, $pIfcHandle);
# pInterfaceName : LPSTR -> LPCSTR
# ClientHandle : HANDLE -> HANDLE
# ClIfcCtx : HANDLE -> HANDLE
# pIfcHandle : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い