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

FilterGetMessage

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

シグネチャ

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

HRESULT FilterGetMessage(
    HANDLE hPort,
    FILTER_MESSAGE_HEADER* lpMessageBuffer,
    DWORD dwMessageBufferSize,
    OVERLAPPED* lpOverlapped   // optional
);

パラメーター

名前方向説明
hPortHANDLEinメッセージを受信するフィルター通信ポートのハンドル。
lpMessageBufferFILTER_MESSAGE_HEADER*out受信メッセージを受け取るFILTER_MESSAGE_HEADERバッファへのポインタ。
dwMessageBufferSizeDWORDinlpMessageBufferのサイズをバイト単位で指定する。
lpOverlappedOVERLAPPED*inoutoptional非同期受信に用いるOVERLAPPED構造体へのポインタ。同期時はNULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

FilterGetMessage = ctypes.windll.fltlib.FilterGetMessage
FilterGetMessage.restype = ctypes.c_int
FilterGetMessage.argtypes = [
    wintypes.HANDLE,  # hPort : HANDLE
    ctypes.c_void_p,  # lpMessageBuffer : FILTER_MESSAGE_HEADER* out
    wintypes.DWORD,  # dwMessageBufferSize : DWORD
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	fltlib = windows.NewLazySystemDLL("FLTLIB.dll")
	procFilterGetMessage = fltlib.NewProc("FilterGetMessage")
)

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

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

typedef FilterGetMessageNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Void>);
typedef FilterGetMessageDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>);
final FilterGetMessage = DynamicLibrary.open('FLTLIB.dll')
    .lookupFunction<FilterGetMessageNative, FilterGetMessageDart>('FilterGetMessage');
// hPort : HANDLE -> Pointer<Void>
// lpMessageBuffer : FILTER_MESSAGE_HEADER* out -> Pointer<Void>
// dwMessageBufferSize : DWORD -> Uint32
// lpOverlapped : OVERLAPPED* optional, in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FilterGetMessage(
  hPort: THandle;   // HANDLE
  lpMessageBuffer: Pointer;   // FILTER_MESSAGE_HEADER* out
  dwMessageBufferSize: DWORD;   // DWORD
  lpOverlapped: Pointer   // OVERLAPPED* optional, in/out
): Integer; stdcall;
  external 'FLTLIB.dll' name 'FilterGetMessage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FilterGetMessage"
  c_FilterGetMessage :: Ptr () -> Ptr () -> Word32 -> Ptr () -> IO Int32
-- hPort : HANDLE -> Ptr ()
-- lpMessageBuffer : FILTER_MESSAGE_HEADER* out -> Ptr ()
-- dwMessageBufferSize : DWORD -> Word32
-- lpOverlapped : OVERLAPPED* optional, in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let filtergetmessage =
  foreign "FilterGetMessage"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* hPort : HANDLE -> (ptr void) *)
(* lpMessageBuffer : FILTER_MESSAGE_HEADER* out -> (ptr void) *)
(* dwMessageBufferSize : DWORD -> uint32_t *)
(* lpOverlapped : OVERLAPPED* optional, in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library fltlib (t "FLTLIB.dll"))
(cffi:use-foreign-library fltlib)

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

関連項目

使用する型