Win32 API 日本語リファレンス
ホームSystem.Ole › RegisterDragDrop

RegisterDragDrop

関数
ウィンドウをドロップ対象としてドラッグアンドドロップに登録する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT RegisterDragDrop(
    HWND hwnd,
    IDropTarget* pDropTarget
);

パラメーター

名前方向説明
hwndHWNDinOLE ドラッグアンドドロップ操作のターゲットになり得るウィンドウのハンドル。
pDropTargetIDropTarget*in指定したウィンドウでドラッグアンドドロップ操作のターゲットとなるオブジェクト上の IDropTarget インターフェイスへのポインター。このインターフェイスは、そのウィンドウに関する OLE ドラッグアンドドロップ情報をやり取りするために使用されます。

戻り値の型: HRESULT

公式ドキュメント

指定したウィンドウを OLE ドラッグアンドドロップ操作のターゲットになり得るウィンドウとして登録し、ドロップ操作に使用する IDropTarget インスタンスを指定します。

戻り値

この関数は成功すると S_OK を返します。そのほかに考えられる値には次のものがあります。

戻り値 説明
DRAGDROP_E_INVALIDHWND
hwnd パラメーターで無効なハンドルが返されました。
DRAGDROP_E_ALREADYREGISTERED
指定したウィンドウは既にドロップターゲットとして登録されています。
E_OUTOFMEMORY
操作に必要なメモリが不足しています。
注意 COM の初期化に OleInitialize ではなく CoInitialize または CoInitializeEx を使用した場合、RegisterDragDrop は常に E_OUTOFMEMORY エラーを返します。

解説(Remarks)

アプリケーションが OLE ドラッグアンドドロップ操作中にドロップされたオブジェクトを受け入れられる場合は、RegisterDragDrop 関数を呼び出す必要があります。アプリケーションのウィンドウのいずれかがドロップターゲットの候補として利用可能になったとき、つまりウィンドウが画面上で隠されずに表示されているときに、これを行います。

RegisterDragDrop 関数を呼び出すアプリケーションスレッドはメッセージをポンプしている必要があります。これはおそらく、hWnd パラメーターを NULL にして GetMessage 関数を呼び出すことによって行います。OLE がそのスレッド上にメッセージ処理を必要とするウィンドウを作成するためです。この要件が満たされない場合、ドロップターゲットとして登録されたウィンドウ上にオブジェクトをドラッグするアプリケーションは、ターゲットアプリケーションが閉じられるまでハングします。

RegisterDragDrop 関数は一度に 1 つのウィンドウしか登録しないため、ドロップされたオブジェクトを受け入れることができるアプリケーションウィンドウごとに呼び出す必要があります。

OLE ドラッグアンドドロップ操作中にマウスがターゲットウィンドウの隠されていない部分を通過すると、DoDragDrop 関数が現在のウィンドウに対して指定された IDropTarget::DragOver メソッドを呼び出します。あるウィンドウで実際にドロップ操作が発生すると、DoDragDrop 関数は IDropTarget::Drop を呼び出します。

RegisterDragDrop 関数は、IDropTarget ポインターに対して IUnknown::AddRef メソッドも呼び出します。

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

各言語での呼び出し定義

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

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

RegisterDragDrop = ctypes.windll.ole32.RegisterDragDrop
RegisterDragDrop.restype = ctypes.c_int
RegisterDragDrop.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND
    ctypes.c_void_p,  # pDropTarget : IDropTarget*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procRegisterDragDrop = ole32.NewProc("RegisterDragDrop")
)

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

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

typedef RegisterDragDropNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef RegisterDragDropDart = int Function(Pointer<Void>, Pointer<Void>);
final RegisterDragDrop = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<RegisterDragDropNative, RegisterDragDropDart>('RegisterDragDrop');
// hwnd : HWND -> Pointer<Void>
// pDropTarget : IDropTarget* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RegisterDragDrop(
  hwnd: THandle;   // HWND
  pDropTarget: Pointer   // IDropTarget*
): Integer; stdcall;
  external 'OLE32.dll' name 'RegisterDragDrop';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RegisterDragDrop"
  c_RegisterDragDrop :: Ptr () -> Ptr () -> IO Int32
-- hwnd : HWND -> Ptr ()
-- pDropTarget : IDropTarget* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let registerdragdrop =
  foreign "RegisterDragDrop"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hwnd : HWND -> (ptr void) *)
(* pDropTarget : IDropTarget* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("RegisterDragDrop" register-drag-drop :convention :stdcall) :int32
  (hwnd :pointer)   ; HWND
  (p-drop-target :pointer))   ; IDropTarget*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RegisterDragDrop = Win32::API::More->new('OLE32',
    'int RegisterDragDrop(HANDLE hwnd, LPVOID pDropTarget)');
# my $ret = $RegisterDragDrop->Call($hwnd, $pDropTarget);
# hwnd : HWND -> HANDLE
# pDropTarget : IDropTarget* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型