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

PfTestPacket

関数
指定パケットに対するフィルタの転送動作をテストする。
DLLIPHLPAPI.dll呼出規約winapi

シグネチャ

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

DWORD PfTestPacket(
    void* pInInterface,
    void* pOutInterface,
    DWORD cBytes,
    BYTE* pbPacket,
    PFFORWARD_ACTION* ppAction
);

パラメーター

名前型方向説明
pInInterfacevoid*inout受信側インターフェースのハンドル。不要ならNULL可。
pOutInterfacevoid*inout送信側インターフェースのハンドル。不要ならNULL可。
cBytesDWORDinpbPacketが指すパケットデータのバイト数。
pbPacketBYTE*inout判定対象のパケットデータへのポインタ。
ppActionPFFORWARD_ACTION*inout適用されるべき転送アクション(PFFORWARD_ACTION)を受け取る出力ポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD PfTestPacket(
    void* pInInterface,
    void* pOutInterface,
    DWORD cBytes,
    BYTE* pbPacket,
    PFFORWARD_ACTION* ppAction
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint PfTestPacket(
    IntPtr pInInterface,   // void* in/out
    IntPtr pOutInterface,   // void* in/out
    uint cBytes,   // DWORD
    IntPtr pbPacket,   // BYTE* in/out
    ref int ppAction   // PFFORWARD_ACTION* in/out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function PfTestPacket(
    pInInterface As IntPtr,   ' void* in/out
    pOutInterface As IntPtr,   ' void* in/out
    cBytes As UInteger,   ' DWORD
    pbPacket As IntPtr,   ' BYTE* in/out
    ByRef ppAction As Integer   ' PFFORWARD_ACTION* in/out
) As UInteger
End Function
' pInInterface : void* in/out
' pOutInterface : void* in/out
' cBytes : DWORD
' pbPacket : BYTE* in/out
' ppAction : PFFORWARD_ACTION* in/out
Declare PtrSafe Function PfTestPacket Lib "iphlpapi" ( _
    ByVal pInInterface As LongPtr, _
    ByVal pOutInterface As LongPtr, _
    ByVal cBytes As Long, _
    ByVal pbPacket As LongPtr, _
    ByRef ppAction As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PfTestPacket = ctypes.windll.iphlpapi.PfTestPacket
PfTestPacket.restype = wintypes.DWORD
PfTestPacket.argtypes = [
    ctypes.POINTER(None),  # pInInterface : void* in/out
    ctypes.POINTER(None),  # pOutInterface : void* in/out
    wintypes.DWORD,  # cBytes : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbPacket : BYTE* in/out
    ctypes.c_void_p,  # ppAction : PFFORWARD_ACTION* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
PfTestPacket = Fiddle::Function.new(
  lib['PfTestPacket'],
  [
    Fiddle::TYPE_VOIDP,  # pInInterface : void* in/out
    Fiddle::TYPE_VOIDP,  # pOutInterface : void* in/out
    -Fiddle::TYPE_INT,  # cBytes : DWORD
    Fiddle::TYPE_VOIDP,  # pbPacket : BYTE* in/out
    Fiddle::TYPE_VOIDP,  # ppAction : PFFORWARD_ACTION* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn PfTestPacket(
        pInInterface: *mut (),  // void* in/out
        pOutInterface: *mut (),  // void* in/out
        cBytes: u32,  // DWORD
        pbPacket: *mut u8,  // BYTE* in/out
        ppAction: *mut i32  // PFFORWARD_ACTION* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint PfTestPacket(IntPtr pInInterface, IntPtr pOutInterface, uint cBytes, IntPtr pbPacket, ref int ppAction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_PfTestPacket' -Namespace Win32 -PassThru
# $api::PfTestPacket(pInInterface, pOutInterface, cBytes, pbPacket, ppAction)
#uselib "IPHLPAPI.dll"
#func global PfTestPacket "PfTestPacket" sptr, sptr, sptr, sptr, sptr
; PfTestPacket pInInterface, pOutInterface, cBytes, varptr(pbPacket), varptr(ppAction)   ; 戻り値は stat
; pInInterface : void* in/out -> "sptr"
; pOutInterface : void* in/out -> "sptr"
; cBytes : DWORD -> "sptr"
; pbPacket : BYTE* in/out -> "sptr"
; ppAction : PFFORWARD_ACTION* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "IPHLPAPI.dll"
#cfunc global PfTestPacket "PfTestPacket" sptr, sptr, int, var, var
; res = PfTestPacket(pInInterface, pOutInterface, cBytes, pbPacket, ppAction)
; pInInterface : void* in/out -> "sptr"
; pOutInterface : void* in/out -> "sptr"
; cBytes : DWORD -> "int"
; pbPacket : BYTE* in/out -> "var"
; ppAction : PFFORWARD_ACTION* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; DWORD PfTestPacket(void* pInInterface, void* pOutInterface, DWORD cBytes, BYTE* pbPacket, PFFORWARD_ACTION* ppAction)
#uselib "IPHLPAPI.dll"
#cfunc global PfTestPacket "PfTestPacket" intptr, intptr, int, var, var
; res = PfTestPacket(pInInterface, pOutInterface, cBytes, pbPacket, ppAction)
; pInInterface : void* in/out -> "intptr"
; pOutInterface : void* in/out -> "intptr"
; cBytes : DWORD -> "int"
; pbPacket : BYTE* in/out -> "var"
; ppAction : PFFORWARD_ACTION* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procPfTestPacket = iphlpapi.NewProc("PfTestPacket")
)

// pInInterface (void* in/out), pOutInterface (void* in/out), cBytes (DWORD), pbPacket (BYTE* in/out), ppAction (PFFORWARD_ACTION* in/out)
r1, _, err := procPfTestPacket.Call(
	uintptr(pInInterface),
	uintptr(pOutInterface),
	uintptr(cBytes),
	uintptr(pbPacket),
	uintptr(ppAction),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function PfTestPacket(
  pInInterface: Pointer;   // void* in/out
  pOutInterface: Pointer;   // void* in/out
  cBytes: DWORD;   // DWORD
  pbPacket: Pointer;   // BYTE* in/out
  ppAction: Pointer   // PFFORWARD_ACTION* in/out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'PfTestPacket';
result := DllCall("IPHLPAPI\PfTestPacket"
    , "Ptr", pInInterface   ; void* in/out
    , "Ptr", pOutInterface   ; void* in/out
    , "UInt", cBytes   ; DWORD
    , "Ptr", pbPacket   ; BYTE* in/out
    , "Ptr", ppAction   ; PFFORWARD_ACTION* in/out
    , "UInt")   ; return: DWORD
●PfTestPacket(pInInterface, pOutInterface, cBytes, pbPacket, ppAction) = DLL("IPHLPAPI.dll", "dword PfTestPacket(void*, void*, dword, void*, void*)")
# 呼び出し: PfTestPacket(pInInterface, pOutInterface, cBytes, pbPacket, ppAction)
# pInInterface : void* in/out -> "void*"
# pOutInterface : void* in/out -> "void*"
# cBytes : DWORD -> "dword"
# pbPacket : BYTE* in/out -> "void*"
# ppAction : PFFORWARD_ACTION* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn PfTestPacket(
    pInInterface: ?*anyopaque, // void* in/out
    pOutInterface: ?*anyopaque, // void* in/out
    cBytes: u32, // DWORD
    pbPacket: [*c]u8, // BYTE* in/out
    ppAction: [*c]i32 // PFFORWARD_ACTION* in/out
) callconv(std.os.windows.WINAPI) u32;
proc PfTestPacket(
    pInInterface: pointer,  # void* in/out
    pOutInterface: pointer,  # void* in/out
    cBytes: uint32,  # DWORD
    pbPacket: ptr uint8,  # BYTE* in/out
    ppAction: ptr int32  # PFFORWARD_ACTION* in/out
): uint32 {.importc: "PfTestPacket", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint PfTestPacket(
    void* pInInterface,   // void* in/out
    void* pOutInterface,   // void* in/out
    uint cBytes,   // DWORD
    ubyte* pbPacket,   // BYTE* in/out
    int* ppAction   // PFFORWARD_ACTION* in/out
);
ccall((:PfTestPacket, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{Cvoid}, UInt32, Ptr{UInt8}, Ptr{Int32}),
      pInInterface, pOutInterface, cBytes, pbPacket, ppAction)
# pInInterface : void* in/out -> Ptr{Cvoid}
# pOutInterface : void* in/out -> Ptr{Cvoid}
# cBytes : DWORD -> UInt32
# pbPacket : BYTE* in/out -> Ptr{UInt8}
# ppAction : PFFORWARD_ACTION* in/out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PfTestPacket(
    void* pInInterface,
    void* pOutInterface,
    uint32_t cBytes,
    uint8_t* pbPacket,
    int32_t* ppAction);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.PfTestPacket(pInInterface, pOutInterface, cBytes, pbPacket, ppAction)
-- pInInterface : void* in/out
-- pOutInterface : void* in/out
-- cBytes : DWORD
-- pbPacket : BYTE* in/out
-- ppAction : PFFORWARD_ACTION* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const PfTestPacket = lib.func('__stdcall', 'PfTestPacket', 'uint32_t', ['void *', 'void *', 'uint32_t', 'uint8_t *', 'int32_t *']);
// PfTestPacket(pInInterface, pOutInterface, cBytes, pbPacket, ppAction)
// pInInterface : void* in/out -> 'void *'
// pOutInterface : void* in/out -> 'void *'
// cBytes : DWORD -> 'uint32_t'
// pbPacket : BYTE* in/out -> 'uint8_t *'
// ppAction : PFFORWARD_ACTION* in/out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  PfTestPacket: { parameters: ["pointer", "pointer", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.PfTestPacket(pInInterface, pOutInterface, cBytes, pbPacket, ppAction)
// pInInterface : void* in/out -> "pointer"
// pOutInterface : void* in/out -> "pointer"
// cBytes : DWORD -> "u32"
// pbPacket : BYTE* in/out -> "pointer"
// ppAction : PFFORWARD_ACTION* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PfTestPacket(
    void* pInInterface,
    void* pOutInterface,
    uint32_t cBytes,
    uint8_t* pbPacket,
    int32_t* ppAction);
C, "IPHLPAPI.dll");
// $ffi->PfTestPacket(pInInterface, pOutInterface, cBytes, pbPacket, ppAction);
// pInInterface : void* in/out
// pOutInterface : void* in/out
// cBytes : DWORD
// pbPacket : BYTE* in/out
// ppAction : PFFORWARD_ACTION* in/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 Iphlpapi extends StdCallLibrary {
    Iphlpapi INSTANCE = Native.load("iphlpapi", Iphlpapi.class);
    int PfTestPacket(
        Pointer pInInterface,   // void* in/out
        Pointer pOutInterface,   // void* in/out
        int cBytes,   // DWORD
        byte[] pbPacket,   // BYTE* in/out
        IntByReference ppAction   // PFFORWARD_ACTION* in/out
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun PfTestPacket = PfTestPacket(
    pInInterface : Void*,   # void* in/out
    pOutInterface : Void*,   # void* in/out
    cBytes : UInt32,   # DWORD
    pbPacket : UInt8*,   # BYTE* in/out
    ppAction : Int32*   # PFFORWARD_ACTION* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PfTestPacketNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Uint8>, Pointer<Int32>);
typedef PfTestPacketDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Uint8>, Pointer<Int32>);
final PfTestPacket = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<PfTestPacketNative, PfTestPacketDart>('PfTestPacket');
// pInInterface : void* in/out -> Pointer<Void>
// pOutInterface : void* in/out -> Pointer<Void>
// cBytes : DWORD -> Uint32
// pbPacket : BYTE* in/out -> Pointer<Uint8>
// ppAction : PFFORWARD_ACTION* in/out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PfTestPacket(
  pInInterface: Pointer;   // void* in/out
  pOutInterface: Pointer;   // void* in/out
  cBytes: DWORD;   // DWORD
  pbPacket: Pointer;   // BYTE* in/out
  ppAction: Pointer   // PFFORWARD_ACTION* in/out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'PfTestPacket';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PfTestPacket"
  c_PfTestPacket :: Ptr () -> Ptr () -> Word32 -> Ptr Word8 -> Ptr Int32 -> IO Word32
-- pInInterface : void* in/out -> Ptr ()
-- pOutInterface : void* in/out -> Ptr ()
-- cBytes : DWORD -> Word32
-- pbPacket : BYTE* in/out -> Ptr Word8
-- ppAction : PFFORWARD_ACTION* in/out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pftestpacket =
  foreign "PfTestPacket"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr uint8_t) @-> (ptr int32_t) @-> returning uint32_t)
(* pInInterface : void* in/out -> (ptr void) *)
(* pOutInterface : void* in/out -> (ptr void) *)
(* cBytes : DWORD -> uint32_t *)
(* pbPacket : BYTE* in/out -> (ptr uint8_t) *)
(* ppAction : PFFORWARD_ACTION* in/out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("PfTestPacket" pf-test-packet :convention :stdcall) :uint32
  (p-in-interface :pointer)   ; void* in/out
  (p-out-interface :pointer)   ; void* in/out
  (c-bytes :uint32)   ; DWORD
  (pb-packet :pointer)   ; BYTE* in/out
  (pp-action :pointer))   ; PFFORWARD_ACTION* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PfTestPacket = Win32::API::More->new('IPHLPAPI',
    'DWORD PfTestPacket(LPVOID pInInterface, LPVOID pOutInterface, DWORD cBytes, LPVOID pbPacket, LPVOID ppAction)');
# my $ret = $PfTestPacket->Call($pInInterface, $pOutInterface, $cBytes, $pbPacket, $ppAction);
# pInInterface : void* in/out -> LPVOID
# pOutInterface : void* in/out -> LPVOID
# cBytes : DWORD -> DWORD
# pbPacket : BYTE* in/out -> LPVOID
# ppAction : PFFORWARD_ACTION* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型