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

DriverCallback

関数
メディアデバイスのコールバック通知を呼び出す。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL DriverCallback(
    UINT_PTR dwCallback,
    DWORD dwFlags,
    HDRVR hDevice,
    DWORD dwMsg,
    UINT_PTR dwUser,
    UINT_PTR dwParam1,
    UINT_PTR dwParam2
);

パラメーター

名前方向説明
dwCallbackUINT_PTRindwFlags パラメーターで指定するフラグに応じて、コールバック関数のアドレス、ウィンドウハンドル、またはタスクハンドルを指定します。
dwFlagsDWORDin

通知フラグ。次のいずれかの値を指定できます。

意味
DCB_NOSWITCH
システムによるスタックの切り替えを抑止します。この値は、コールバック関数に十分なスタック領域が存在することが確実な場合にのみ使用します。
DCB_FUNCTION
dwCallback パラメーターは、アプリケーション定義のコールバック関数のアドレスです。システムはコールバックメッセージをそのコールバック関数に送信します。
DCB_WINDOW
dwCallback パラメーターは、アプリケーション定義のウィンドウのハンドルです。システムはそれ以降の通知をそのウィンドウに送信します。
DCB_TASK
dwCallback パラメーターは、アプリケーションまたはタスクのハンドルです。システムはそれ以降の通知をそのアプリケーションまたはタスクに送信します。
hDeviceHDRVRinインストール可能ドライバーのインスタンスのハンドル。
dwMsgDWORDinメッセージの値。
dwUserUINT_PTRinデバイスを開いた際にアプリケーションが指定した 32 ビットのユーザーインスタンスデータ。
dwParam1UINT_PTRinメッセージに依存する 32 ビットのパラメーター。
dwParam2UINT_PTRinメッセージに依存する 32 ビットのパラメーター。

戻り値の型: BOOL

公式ドキュメント

コールバック関数を呼び出す、ウィンドウにメッセージを送信する、またはスレッドのブロックを解除します。動作は通知フラグの値によって異なります。この関数は、インストール可能ドライバーの DriverProc 関数内でのみ使用することを目的としています。

戻り値

成功した場合は TRUE を返します。パラメーターが無効な場合、またはタスクのメッセージキューが満杯の場合は FALSE を返します。

解説(Remarks)

クライアントは、デバイスを開く際に自身へ通知する方法を指定します。DCB_FUNCTION フラグおよび DCB_WINDOW フラグは、デバイスを開いた際の DRV_OPEN メッセージの lParam2 パラメーターで指定される対応するフラグ CALLBACK_FUNCTION および CALLBACK_WINDOW の上位ワードに相当します。

コールバック関数によって通知を行う場合、hdrvrmsgdwUserdwParam1、および dwParam2 がコールバック関数に渡されます。ウィンドウによって通知を行う場合は、msghdrvr、および dwParam1 のみがウィンドウに渡されます。

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

各言語での呼び出し定義

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

BOOL DriverCallback(
    UINT_PTR dwCallback,
    DWORD dwFlags,
    HDRVR hDevice,
    DWORD dwMsg,
    UINT_PTR dwUser,
    UINT_PTR dwParam1,
    UINT_PTR dwParam2
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern bool DriverCallback(
    UIntPtr dwCallback,   // UINT_PTR
    uint dwFlags,   // DWORD
    IntPtr hDevice,   // HDRVR
    uint dwMsg,   // DWORD
    UIntPtr dwUser,   // UINT_PTR
    UIntPtr dwParam1,   // UINT_PTR
    UIntPtr dwParam2   // UINT_PTR
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function DriverCallback(
    dwCallback As UIntPtr,   ' UINT_PTR
    dwFlags As UInteger,   ' DWORD
    hDevice As IntPtr,   ' HDRVR
    dwMsg As UInteger,   ' DWORD
    dwUser As UIntPtr,   ' UINT_PTR
    dwParam1 As UIntPtr,   ' UINT_PTR
    dwParam2 As UIntPtr   ' UINT_PTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' dwCallback : UINT_PTR
' dwFlags : DWORD
' hDevice : HDRVR
' dwMsg : DWORD
' dwUser : UINT_PTR
' dwParam1 : UINT_PTR
' dwParam2 : UINT_PTR
Declare PtrSafe Function DriverCallback Lib "winmm" ( _
    ByVal dwCallback As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal hDevice As LongPtr, _
    ByVal dwMsg As Long, _
    ByVal dwUser As LongPtr, _
    ByVal dwParam1 As LongPtr, _
    ByVal dwParam2 As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DriverCallback = ctypes.windll.winmm.DriverCallback
DriverCallback.restype = wintypes.BOOL
DriverCallback.argtypes = [
    ctypes.c_size_t,  # dwCallback : UINT_PTR
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.HANDLE,  # hDevice : HDRVR
    wintypes.DWORD,  # dwMsg : DWORD
    ctypes.c_size_t,  # dwUser : UINT_PTR
    ctypes.c_size_t,  # dwParam1 : UINT_PTR
    ctypes.c_size_t,  # dwParam2 : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
DriverCallback = Fiddle::Function.new(
  lib['DriverCallback'],
  [
    Fiddle::TYPE_UINTPTR_T,  # dwCallback : UINT_PTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # hDevice : HDRVR
    -Fiddle::TYPE_INT,  # dwMsg : DWORD
    Fiddle::TYPE_UINTPTR_T,  # dwUser : UINT_PTR
    Fiddle::TYPE_UINTPTR_T,  # dwParam1 : UINT_PTR
    Fiddle::TYPE_UINTPTR_T,  # dwParam2 : UINT_PTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "winmm")]
extern "system" {
    fn DriverCallback(
        dwCallback: usize,  // UINT_PTR
        dwFlags: u32,  // DWORD
        hDevice: *mut core::ffi::c_void,  // HDRVR
        dwMsg: u32,  // DWORD
        dwUser: usize,  // UINT_PTR
        dwParam1: usize,  // UINT_PTR
        dwParam2: usize  // UINT_PTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINMM.dll")]
public static extern bool DriverCallback(UIntPtr dwCallback, uint dwFlags, IntPtr hDevice, uint dwMsg, UIntPtr dwUser, UIntPtr dwParam1, UIntPtr dwParam2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_DriverCallback' -Namespace Win32 -PassThru
# $api::DriverCallback(dwCallback, dwFlags, hDevice, dwMsg, dwUser, dwParam1, dwParam2)
#uselib "WINMM.dll"
#func global DriverCallback "DriverCallback" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DriverCallback dwCallback, dwFlags, hDevice, dwMsg, dwUser, dwParam1, dwParam2   ; 戻り値は stat
; dwCallback : UINT_PTR -> "sptr"
; dwFlags : DWORD -> "sptr"
; hDevice : HDRVR -> "sptr"
; dwMsg : DWORD -> "sptr"
; dwUser : UINT_PTR -> "sptr"
; dwParam1 : UINT_PTR -> "sptr"
; dwParam2 : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINMM.dll"
#cfunc global DriverCallback "DriverCallback" sptr, int, sptr, int, sptr, sptr, sptr
; res = DriverCallback(dwCallback, dwFlags, hDevice, dwMsg, dwUser, dwParam1, dwParam2)
; dwCallback : UINT_PTR -> "sptr"
; dwFlags : DWORD -> "int"
; hDevice : HDRVR -> "sptr"
; dwMsg : DWORD -> "int"
; dwUser : UINT_PTR -> "sptr"
; dwParam1 : UINT_PTR -> "sptr"
; dwParam2 : UINT_PTR -> "sptr"
; BOOL DriverCallback(UINT_PTR dwCallback, DWORD dwFlags, HDRVR hDevice, DWORD dwMsg, UINT_PTR dwUser, UINT_PTR dwParam1, UINT_PTR dwParam2)
#uselib "WINMM.dll"
#cfunc global DriverCallback "DriverCallback" intptr, int, intptr, int, intptr, intptr, intptr
; res = DriverCallback(dwCallback, dwFlags, hDevice, dwMsg, dwUser, dwParam1, dwParam2)
; dwCallback : UINT_PTR -> "intptr"
; dwFlags : DWORD -> "int"
; hDevice : HDRVR -> "intptr"
; dwMsg : DWORD -> "int"
; dwUser : UINT_PTR -> "intptr"
; dwParam1 : UINT_PTR -> "intptr"
; dwParam2 : UINT_PTR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procDriverCallback = winmm.NewProc("DriverCallback")
)

// dwCallback (UINT_PTR), dwFlags (DWORD), hDevice (HDRVR), dwMsg (DWORD), dwUser (UINT_PTR), dwParam1 (UINT_PTR), dwParam2 (UINT_PTR)
r1, _, err := procDriverCallback.Call(
	uintptr(dwCallback),
	uintptr(dwFlags),
	uintptr(hDevice),
	uintptr(dwMsg),
	uintptr(dwUser),
	uintptr(dwParam1),
	uintptr(dwParam2),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function DriverCallback(
  dwCallback: NativeUInt;   // UINT_PTR
  dwFlags: DWORD;   // DWORD
  hDevice: THandle;   // HDRVR
  dwMsg: DWORD;   // DWORD
  dwUser: NativeUInt;   // UINT_PTR
  dwParam1: NativeUInt;   // UINT_PTR
  dwParam2: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'WINMM.dll' name 'DriverCallback';
result := DllCall("WINMM\DriverCallback"
    , "UPtr", dwCallback   ; UINT_PTR
    , "UInt", dwFlags   ; DWORD
    , "Ptr", hDevice   ; HDRVR
    , "UInt", dwMsg   ; DWORD
    , "UPtr", dwUser   ; UINT_PTR
    , "UPtr", dwParam1   ; UINT_PTR
    , "UPtr", dwParam2   ; UINT_PTR
    , "Int")   ; return: BOOL
●DriverCallback(dwCallback, dwFlags, hDevice, dwMsg, dwUser, dwParam1, dwParam2) = DLL("WINMM.dll", "bool DriverCallback(int, dword, void*, dword, int, int, int)")
# 呼び出し: DriverCallback(dwCallback, dwFlags, hDevice, dwMsg, dwUser, dwParam1, dwParam2)
# dwCallback : UINT_PTR -> "int"
# dwFlags : DWORD -> "dword"
# hDevice : HDRVR -> "void*"
# dwMsg : DWORD -> "dword"
# dwUser : UINT_PTR -> "int"
# dwParam1 : UINT_PTR -> "int"
# dwParam2 : UINT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef DriverCallbackNative = Int32 Function(UintPtr, Uint32, Pointer<Void>, Uint32, UintPtr, UintPtr, UintPtr);
typedef DriverCallbackDart = int Function(int, int, Pointer<Void>, int, int, int, int);
final DriverCallback = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<DriverCallbackNative, DriverCallbackDart>('DriverCallback');
// dwCallback : UINT_PTR -> UintPtr
// dwFlags : DWORD -> Uint32
// hDevice : HDRVR -> Pointer<Void>
// dwMsg : DWORD -> Uint32
// dwUser : UINT_PTR -> UintPtr
// dwParam1 : UINT_PTR -> UintPtr
// dwParam2 : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DriverCallback(
  dwCallback: NativeUInt;   // UINT_PTR
  dwFlags: DWORD;   // DWORD
  hDevice: THandle;   // HDRVR
  dwMsg: DWORD;   // DWORD
  dwUser: NativeUInt;   // UINT_PTR
  dwParam1: NativeUInt;   // UINT_PTR
  dwParam2: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'WINMM.dll' name 'DriverCallback';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DriverCallback"
  c_DriverCallback :: CUIntPtr -> Word32 -> Ptr () -> Word32 -> CUIntPtr -> CUIntPtr -> CUIntPtr -> IO CInt
-- dwCallback : UINT_PTR -> CUIntPtr
-- dwFlags : DWORD -> Word32
-- hDevice : HDRVR -> Ptr ()
-- dwMsg : DWORD -> Word32
-- dwUser : UINT_PTR -> CUIntPtr
-- dwParam1 : UINT_PTR -> CUIntPtr
-- dwParam2 : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let drivercallback =
  foreign "DriverCallback"
    (size_t @-> uint32_t @-> (ptr void) @-> uint32_t @-> size_t @-> size_t @-> size_t @-> returning int32_t)
(* dwCallback : UINT_PTR -> size_t *)
(* dwFlags : DWORD -> uint32_t *)
(* hDevice : HDRVR -> (ptr void) *)
(* dwMsg : DWORD -> uint32_t *)
(* dwUser : UINT_PTR -> size_t *)
(* dwParam1 : UINT_PTR -> size_t *)
(* dwParam2 : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winmm (t "WINMM.dll"))
(cffi:use-foreign-library winmm)

(cffi:defcfun ("DriverCallback" driver-callback :convention :stdcall) :int32
  (dw-callback :uint64)   ; UINT_PTR
  (dw-flags :uint32)   ; DWORD
  (h-device :pointer)   ; HDRVR
  (dw-msg :uint32)   ; DWORD
  (dw-user :uint64)   ; UINT_PTR
  (dw-param1 :uint64)   ; UINT_PTR
  (dw-param2 :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DriverCallback = Win32::API::More->new('WINMM',
    'BOOL DriverCallback(WPARAM dwCallback, DWORD dwFlags, HANDLE hDevice, DWORD dwMsg, WPARAM dwUser, WPARAM dwParam1, WPARAM dwParam2)');
# my $ret = $DriverCallback->Call($dwCallback, $dwFlags, $hDevice, $dwMsg, $dwUser, $dwParam1, $dwParam2);
# dwCallback : UINT_PTR -> WPARAM
# dwFlags : DWORD -> DWORD
# hDevice : HDRVR -> HANDLE
# dwMsg : DWORD -> DWORD
# dwUser : UINT_PTR -> WPARAM
# dwParam1 : UINT_PTR -> WPARAM
# dwParam2 : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。