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

TcGetFlowNameA

関数
フローハンドルからフロー名を取得する(ANSI版)。
DLLTRAFFIC.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD TcGetFlowNameA(
    HANDLE FlowHandle,
    DWORD StrSize,
    LPSTR pFlowName
);

パラメーター

名前方向説明
FlowHandleHANDLEin名前を取得する対象のフローハンドル。
StrSizeDWORDinpFlowNameが指すバッファのバイト数。
pFlowNameLPSTRout取得したフロー名を格納するANSI文字列バッファ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

TcGetFlowNameA = ctypes.windll.traffic.TcGetFlowNameA
TcGetFlowNameA.restype = wintypes.DWORD
TcGetFlowNameA.argtypes = [
    wintypes.HANDLE,  # FlowHandle : HANDLE
    wintypes.DWORD,  # StrSize : DWORD
    wintypes.LPSTR,  # pFlowName : LPSTR out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	traffic = windows.NewLazySystemDLL("TRAFFIC.dll")
	procTcGetFlowNameA = traffic.NewProc("TcGetFlowNameA")
)

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

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

typedef TcGetFlowNameANative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Utf8>);
typedef TcGetFlowNameADart = int Function(Pointer<Void>, int, Pointer<Utf8>);
final TcGetFlowNameA = DynamicLibrary.open('TRAFFIC.dll')
    .lookupFunction<TcGetFlowNameANative, TcGetFlowNameADart>('TcGetFlowNameA');
// FlowHandle : HANDLE -> Pointer<Void>
// StrSize : DWORD -> Uint32
// pFlowName : LPSTR out -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TcGetFlowNameA(
  FlowHandle: THandle;   // HANDLE
  StrSize: DWORD;   // DWORD
  pFlowName: PAnsiChar   // LPSTR out
): DWORD; stdcall;
  external 'TRAFFIC.dll' name 'TcGetFlowNameA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TcGetFlowNameA"
  c_TcGetFlowNameA :: Ptr () -> Word32 -> CString -> IO Word32
-- FlowHandle : HANDLE -> Ptr ()
-- StrSize : DWORD -> Word32
-- pFlowName : LPSTR out -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let tcgetflownamea =
  foreign "TcGetFlowNameA"
    ((ptr void) @-> uint32_t @-> string @-> returning uint32_t)
(* FlowHandle : HANDLE -> (ptr void) *)
(* StrSize : DWORD -> uint32_t *)
(* pFlowName : LPSTR out -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library traffic (t "TRAFFIC.dll"))
(cffi:use-foreign-library traffic)

(cffi:defcfun ("TcGetFlowNameA" tc-get-flow-name-a :convention :stdcall) :uint32
  (flow-handle :pointer)   ; HANDLE
  (str-size :uint32)   ; DWORD
  (p-flow-name :pointer))   ; LPSTR out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TcGetFlowNameA = Win32::API::More->new('TRAFFIC',
    'DWORD TcGetFlowNameA(HANDLE FlowHandle, DWORD StrSize, LPSTR pFlowName)');
# my $ret = $TcGetFlowNameA->Call($FlowHandle, $StrSize, $pFlowName);
# FlowHandle : HANDLE -> HANDLE
# StrSize : DWORD -> DWORD
# pFlowName : LPSTR out -> LPSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い