Win32 API 日本語リファレンス
ホームStorage.InstallableFileSystems › FilterSendMessage

FilterSendMessage

関数
フィルター通信ポート経由でミニフィルタードライバーへメッセージを送信する。
DLLFLTLIB.dll呼出規約winapi

シグネチャ

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

HRESULT FilterSendMessage(
    HANDLE hPort,
    void* lpInBuffer,
    DWORD dwInBufferSize,
    void* lpOutBuffer,   // optional
    DWORD dwOutBufferSize,
    DWORD* lpBytesReturned
);

パラメーター

名前方向説明
hPortHANDLEinメッセージ送信先のフィルター通信ポートのハンドル。
lpInBuffervoid*inドライバーへ送る入力データのバッファを指す。NULL可。
dwInBufferSizeDWORDinlpInBufferのサイズをバイト単位で指定する。
lpOutBuffervoid*outoptionalドライバーからの応答を受け取るバッファを指す。NULL可。
dwOutBufferSizeDWORDinlpOutBufferのサイズをバイト単位で指定する。
lpBytesReturnedDWORD*out応答に書き込まれたバイト数を受け取るDWORDへのポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT FilterSendMessage(
    HANDLE hPort,
    void* lpInBuffer,
    DWORD dwInBufferSize,
    void* lpOutBuffer,   // optional
    DWORD dwOutBufferSize,
    DWORD* lpBytesReturned
);
[DllImport("FLTLIB.dll", ExactSpelling = true)]
static extern int FilterSendMessage(
    IntPtr hPort,   // HANDLE
    IntPtr lpInBuffer,   // void*
    uint dwInBufferSize,   // DWORD
    IntPtr lpOutBuffer,   // void* optional, out
    uint dwOutBufferSize,   // DWORD
    out uint lpBytesReturned   // DWORD* out
);
<DllImport("FLTLIB.dll", ExactSpelling:=True)>
Public Shared Function FilterSendMessage(
    hPort As IntPtr,   ' HANDLE
    lpInBuffer As IntPtr,   ' void*
    dwInBufferSize As UInteger,   ' DWORD
    lpOutBuffer As IntPtr,   ' void* optional, out
    dwOutBufferSize As UInteger,   ' DWORD
    <Out> ByRef lpBytesReturned As UInteger   ' DWORD* out
) As Integer
End Function
' hPort : HANDLE
' lpInBuffer : void*
' dwInBufferSize : DWORD
' lpOutBuffer : void* optional, out
' dwOutBufferSize : DWORD
' lpBytesReturned : DWORD* out
Declare PtrSafe Function FilterSendMessage Lib "fltlib" ( _
    ByVal hPort As LongPtr, _
    ByVal lpInBuffer As LongPtr, _
    ByVal dwInBufferSize As Long, _
    ByVal lpOutBuffer As LongPtr, _
    ByVal dwOutBufferSize As Long, _
    ByRef lpBytesReturned As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FilterSendMessage = ctypes.windll.fltlib.FilterSendMessage
FilterSendMessage.restype = ctypes.c_int
FilterSendMessage.argtypes = [
    wintypes.HANDLE,  # hPort : HANDLE
    ctypes.POINTER(None),  # lpInBuffer : void*
    wintypes.DWORD,  # dwInBufferSize : DWORD
    ctypes.POINTER(None),  # lpOutBuffer : void* optional, out
    wintypes.DWORD,  # dwOutBufferSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpBytesReturned : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	fltlib = windows.NewLazySystemDLL("FLTLIB.dll")
	procFilterSendMessage = fltlib.NewProc("FilterSendMessage")
)

// hPort (HANDLE), lpInBuffer (void*), dwInBufferSize (DWORD), lpOutBuffer (void* optional, out), dwOutBufferSize (DWORD), lpBytesReturned (DWORD* out)
r1, _, err := procFilterSendMessage.Call(
	uintptr(hPort),
	uintptr(lpInBuffer),
	uintptr(dwInBufferSize),
	uintptr(lpOutBuffer),
	uintptr(dwOutBufferSize),
	uintptr(lpBytesReturned),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function FilterSendMessage(
  hPort: THandle;   // HANDLE
  lpInBuffer: Pointer;   // void*
  dwInBufferSize: DWORD;   // DWORD
  lpOutBuffer: Pointer;   // void* optional, out
  dwOutBufferSize: DWORD;   // DWORD
  lpBytesReturned: Pointer   // DWORD* out
): Integer; stdcall;
  external 'FLTLIB.dll' name 'FilterSendMessage';
result := DllCall("FLTLIB\FilterSendMessage"
    , "Ptr", hPort   ; HANDLE
    , "Ptr", lpInBuffer   ; void*
    , "UInt", dwInBufferSize   ; DWORD
    , "Ptr", lpOutBuffer   ; void* optional, out
    , "UInt", dwOutBufferSize   ; DWORD
    , "Ptr", lpBytesReturned   ; DWORD* out
    , "Int")   ; return: HRESULT
●FilterSendMessage(hPort, lpInBuffer, dwInBufferSize, lpOutBuffer, dwOutBufferSize, lpBytesReturned) = DLL("FLTLIB.dll", "int FilterSendMessage(void*, void*, dword, void*, dword, void*)")
# 呼び出し: FilterSendMessage(hPort, lpInBuffer, dwInBufferSize, lpOutBuffer, dwOutBufferSize, lpBytesReturned)
# hPort : HANDLE -> "void*"
# lpInBuffer : void* -> "void*"
# dwInBufferSize : DWORD -> "dword"
# lpOutBuffer : void* optional, out -> "void*"
# dwOutBufferSize : DWORD -> "dword"
# lpBytesReturned : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef FilterSendMessageNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef FilterSendMessageDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>, int, Pointer<Uint32>);
final FilterSendMessage = DynamicLibrary.open('FLTLIB.dll')
    .lookupFunction<FilterSendMessageNative, FilterSendMessageDart>('FilterSendMessage');
// hPort : HANDLE -> Pointer<Void>
// lpInBuffer : void* -> Pointer<Void>
// dwInBufferSize : DWORD -> Uint32
// lpOutBuffer : void* optional, out -> Pointer<Void>
// dwOutBufferSize : DWORD -> Uint32
// lpBytesReturned : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FilterSendMessage(
  hPort: THandle;   // HANDLE
  lpInBuffer: Pointer;   // void*
  dwInBufferSize: DWORD;   // DWORD
  lpOutBuffer: Pointer;   // void* optional, out
  dwOutBufferSize: DWORD;   // DWORD
  lpBytesReturned: Pointer   // DWORD* out
): Integer; stdcall;
  external 'FLTLIB.dll' name 'FilterSendMessage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FilterSendMessage"
  c_FilterSendMessage :: Ptr () -> Ptr () -> Word32 -> Ptr () -> Word32 -> Ptr Word32 -> IO Int32
-- hPort : HANDLE -> Ptr ()
-- lpInBuffer : void* -> Ptr ()
-- dwInBufferSize : DWORD -> Word32
-- lpOutBuffer : void* optional, out -> Ptr ()
-- dwOutBufferSize : DWORD -> Word32
-- lpBytesReturned : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let filtersendmessage =
  foreign "FilterSendMessage"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* hPort : HANDLE -> (ptr void) *)
(* lpInBuffer : void* -> (ptr void) *)
(* dwInBufferSize : DWORD -> uint32_t *)
(* lpOutBuffer : void* optional, out -> (ptr void) *)
(* dwOutBufferSize : DWORD -> uint32_t *)
(* lpBytesReturned : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library fltlib (t "FLTLIB.dll"))
(cffi:use-foreign-library fltlib)

(cffi:defcfun ("FilterSendMessage" filter-send-message :convention :stdcall) :int32
  (h-port :pointer)   ; HANDLE
  (lp-in-buffer :pointer)   ; void*
  (dw-in-buffer-size :uint32)   ; DWORD
  (lp-out-buffer :pointer)   ; void* optional, out
  (dw-out-buffer-size :uint32)   ; DWORD
  (lp-bytes-returned :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FilterSendMessage = Win32::API::More->new('FLTLIB',
    'int FilterSendMessage(HANDLE hPort, LPVOID lpInBuffer, DWORD dwInBufferSize, LPVOID lpOutBuffer, DWORD dwOutBufferSize, LPVOID lpBytesReturned)');
# my $ret = $FilterSendMessage->Call($hPort, $lpInBuffer, $dwInBufferSize, $lpOutBuffer, $dwOutBufferSize, $lpBytesReturned);
# hPort : HANDLE -> HANDLE
# lpInBuffer : void* -> LPVOID
# dwInBufferSize : DWORD -> DWORD
# lpOutBuffer : void* optional, out -> LPVOID
# dwOutBufferSize : DWORD -> DWORD
# lpBytesReturned : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。