Win32 API 日本語リファレンス
ホームMedia.Audio › CoRegisterMessageFilter

CoRegisterMessageFilter

関数
現在のスレッドにCOMメッセージフィルターを登録する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoRegisterMessageFilter(
    IMessageFilter* lpMessageFilter,   // optional
    IMessageFilter** lplpMessageFilter   // optional
);

パラメーター

名前方向説明
lpMessageFilterIMessageFilter*inoptional

メッセージフィルター上の IMessageFilter インターフェイスへのポインターです。このメッセージフィルターは現在のスレッドに登録され、以前のメッセージフィルター(存在する場合)を置き換えます。このパラメーターには NULL を指定でき、その場合は現在のスレッドにメッセージフィルターを登録しないことを示します。

なお、この関数はメッセージフィルターへのインターフェイスポインターに対して AddRef を呼び出します。

lplpMessageFilterIMessageFilter**outoptional以前に登録されていたメッセージフィルターへのインターフェイスポインターを受け取る IMessageFilter* ポインター変数のアドレスです。現在のスレッドに以前登録されたメッセージフィルターが存在しなかった場合、*lplpMessageFilter の値は NULL になります。

戻り値の型: HRESULT

公式ドキュメント

現在のスレッドにおける並行性の問題を処理するために使用される IMessageFilter インターフェイスのインスタンスを OLE に登録します。

戻り値

インスタンスの登録または取り消しに成功した場合、戻り値は S_OK です。それ以外の場合は S_FALSE です。

解説(Remarks)

登録済みのメッセージフィルターを取り消すには、以前のメッセージフィルター(場合によっては NULL)を lpMessageFilter パラメーターとして CoRegisterMessageFilter に渡します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT CoRegisterMessageFilter(
    IMessageFilter* lpMessageFilter,   // optional
    IMessageFilter** lplpMessageFilter   // optional
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoRegisterMessageFilter(
    IntPtr lpMessageFilter,   // IMessageFilter* optional
    IntPtr lplpMessageFilter   // IMessageFilter** optional, out
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoRegisterMessageFilter(
    lpMessageFilter As IntPtr,   ' IMessageFilter* optional
    lplpMessageFilter As IntPtr   ' IMessageFilter** optional, out
) As Integer
End Function
' lpMessageFilter : IMessageFilter* optional
' lplpMessageFilter : IMessageFilter** optional, out
Declare PtrSafe Function CoRegisterMessageFilter Lib "ole32" ( _
    ByVal lpMessageFilter As LongPtr, _
    ByVal lplpMessageFilter As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CoRegisterMessageFilter = ctypes.windll.ole32.CoRegisterMessageFilter
CoRegisterMessageFilter.restype = ctypes.c_int
CoRegisterMessageFilter.argtypes = [
    ctypes.c_void_p,  # lpMessageFilter : IMessageFilter* optional
    ctypes.c_void_p,  # lplpMessageFilter : IMessageFilter** optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoRegisterMessageFilter = Fiddle::Function.new(
  lib['CoRegisterMessageFilter'],
  [
    Fiddle::TYPE_VOIDP,  # lpMessageFilter : IMessageFilter* optional
    Fiddle::TYPE_VOIDP,  # lplpMessageFilter : IMessageFilter** optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ole32")]
extern "system" {
    fn CoRegisterMessageFilter(
        lpMessageFilter: *mut core::ffi::c_void,  // IMessageFilter* optional
        lplpMessageFilter: *mut *mut core::ffi::c_void  // IMessageFilter** optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoRegisterMessageFilter(IntPtr lpMessageFilter, IntPtr lplpMessageFilter);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoRegisterMessageFilter' -Namespace Win32 -PassThru
# $api::CoRegisterMessageFilter(lpMessageFilter, lplpMessageFilter)
#uselib "OLE32.dll"
#func global CoRegisterMessageFilter "CoRegisterMessageFilter" sptr, sptr
; CoRegisterMessageFilter lpMessageFilter, lplpMessageFilter   ; 戻り値は stat
; lpMessageFilter : IMessageFilter* optional -> "sptr"
; lplpMessageFilter : IMessageFilter** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "OLE32.dll"
#cfunc global CoRegisterMessageFilter "CoRegisterMessageFilter" sptr, sptr
; res = CoRegisterMessageFilter(lpMessageFilter, lplpMessageFilter)
; lpMessageFilter : IMessageFilter* optional -> "sptr"
; lplpMessageFilter : IMessageFilter** optional, out -> "sptr"
; HRESULT CoRegisterMessageFilter(IMessageFilter* lpMessageFilter, IMessageFilter** lplpMessageFilter)
#uselib "OLE32.dll"
#cfunc global CoRegisterMessageFilter "CoRegisterMessageFilter" intptr, intptr
; res = CoRegisterMessageFilter(lpMessageFilter, lplpMessageFilter)
; lpMessageFilter : IMessageFilter* optional -> "intptr"
; lplpMessageFilter : IMessageFilter** optional, out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoRegisterMessageFilter = ole32.NewProc("CoRegisterMessageFilter")
)

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

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

typedef CoRegisterMessageFilterNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef CoRegisterMessageFilterDart = int Function(Pointer<Void>, Pointer<Void>);
final CoRegisterMessageFilter = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoRegisterMessageFilterNative, CoRegisterMessageFilterDart>('CoRegisterMessageFilter');
// lpMessageFilter : IMessageFilter* optional -> Pointer<Void>
// lplpMessageFilter : IMessageFilter** optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoRegisterMessageFilter(
  lpMessageFilter: Pointer;   // IMessageFilter* optional
  lplpMessageFilter: Pointer   // IMessageFilter** optional, out
): Integer; stdcall;
  external 'OLE32.dll' name 'CoRegisterMessageFilter';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CoRegisterMessageFilter"
  c_CoRegisterMessageFilter :: Ptr () -> Ptr () -> IO Int32
-- lpMessageFilter : IMessageFilter* optional -> Ptr ()
-- lplpMessageFilter : IMessageFilter** optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let coregistermessagefilter =
  foreign "CoRegisterMessageFilter"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* lpMessageFilter : IMessageFilter* optional -> (ptr void) *)
(* lplpMessageFilter : IMessageFilter** optional, out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("CoRegisterMessageFilter" co-register-message-filter :convention :stdcall) :int32
  (lp-message-filter :pointer)   ; IMessageFilter* optional
  (lplp-message-filter :pointer))   ; IMessageFilter** optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoRegisterMessageFilter = Win32::API::More->new('OLE32',
    'int CoRegisterMessageFilter(LPVOID lpMessageFilter, LPVOID lplpMessageFilter)');
# my $ret = $CoRegisterMessageFilter->Call($lpMessageFilter, $lplpMessageFilter);
# lpMessageFilter : IMessageFilter* optional -> LPVOID
# lplpMessageFilter : IMessageFilter** optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型