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

TcSetFlowA

関数
指定フローのトラフィック制御パラメータを設定する(ANSI版)。
DLLTRAFFIC.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD TcSetFlowA(
    LPSTR pFlowName,
    GUID* pGuidParam,
    DWORD BufferSize,
    void* Buffer
);

パラメーター

名前方向説明
pFlowNameLPSTRin設定対象のフロー名を指すANSI文字列。
pGuidParamGUID*in設定するパラメータの種類を識別するGUIDへのポインタ。
BufferSizeDWORDinBufferが指す設定データのバイト数。
Buffervoid*in設定するフローパラメータ値を格納したバッファへのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD TcSetFlowA(
    LPSTR pFlowName,
    GUID* pGuidParam,
    DWORD BufferSize,
    void* Buffer
);
[DllImport("TRAFFIC.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint TcSetFlowA(
    [MarshalAs(UnmanagedType.LPStr)] string pFlowName,   // LPSTR
    ref Guid pGuidParam,   // GUID*
    uint BufferSize,   // DWORD
    IntPtr Buffer   // void*
);
<DllImport("TRAFFIC.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function TcSetFlowA(
    <MarshalAs(UnmanagedType.LPStr)> pFlowName As String,   ' LPSTR
    ByRef pGuidParam As Guid,   ' GUID*
    BufferSize As UInteger,   ' DWORD
    Buffer As IntPtr   ' void*
) As UInteger
End Function
' pFlowName : LPSTR
' pGuidParam : GUID*
' BufferSize : DWORD
' Buffer : void*
Declare PtrSafe Function TcSetFlowA Lib "traffic" ( _
    ByVal pFlowName As String, _
    ByVal pGuidParam As LongPtr, _
    ByVal BufferSize As Long, _
    ByVal Buffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TcSetFlowA = ctypes.windll.traffic.TcSetFlowA
TcSetFlowA.restype = wintypes.DWORD
TcSetFlowA.argtypes = [
    wintypes.LPCSTR,  # pFlowName : LPSTR
    ctypes.c_void_p,  # pGuidParam : GUID*
    wintypes.DWORD,  # BufferSize : DWORD
    ctypes.POINTER(None),  # Buffer : void*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	traffic = windows.NewLazySystemDLL("TRAFFIC.dll")
	procTcSetFlowA = traffic.NewProc("TcSetFlowA")
)

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

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

typedef TcSetFlowANative = Uint32 Function(Pointer<Utf8>, Pointer<Void>, Uint32, Pointer<Void>);
typedef TcSetFlowADart = int Function(Pointer<Utf8>, Pointer<Void>, int, Pointer<Void>);
final TcSetFlowA = DynamicLibrary.open('TRAFFIC.dll')
    .lookupFunction<TcSetFlowANative, TcSetFlowADart>('TcSetFlowA');
// pFlowName : LPSTR -> Pointer<Utf8>
// pGuidParam : GUID* -> Pointer<Void>
// BufferSize : DWORD -> Uint32
// Buffer : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TcSetFlowA(
  pFlowName: PAnsiChar;   // LPSTR
  pGuidParam: PGUID;   // GUID*
  BufferSize: DWORD;   // DWORD
  Buffer: Pointer   // void*
): DWORD; stdcall;
  external 'TRAFFIC.dll' name 'TcSetFlowA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TcSetFlowA"
  c_TcSetFlowA :: CString -> Ptr () -> Word32 -> Ptr () -> IO Word32
-- pFlowName : LPSTR -> CString
-- pGuidParam : GUID* -> Ptr ()
-- BufferSize : DWORD -> Word32
-- Buffer : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("TcSetFlowA" tc-set-flow-a :convention :stdcall) :uint32
  (p-flow-name :string)   ; LPSTR
  (p-guid-param :pointer)   ; GUID*
  (buffer-size :uint32)   ; DWORD
  (buffer :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TcSetFlowA = Win32::API::More->new('TRAFFIC',
    'DWORD TcSetFlowA(LPCSTR pFlowName, LPVOID pGuidParam, DWORD BufferSize, LPVOID Buffer)');
# my $ret = $TcSetFlowA->Call($pFlowName, $pGuidParam, $BufferSize, $Buffer);
# pFlowName : LPSTR -> LPCSTR
# pGuidParam : GUID* -> LPVOID
# BufferSize : DWORD -> DWORD
# Buffer : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い