SHDoDragDrop

関数

ドラッグ画像付きでドラッグ&ドロップ操作を実行する。

DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT SHDoDragDrop(
    HWND hwnd,   // optional
    IDataObject* pdata,
    IDropSource* pdsrc,   // optional
    DROPEFFECT dwEffect,
    DROPEFFECT* pdwEffect
);

パラメーター

名前	型	方向	説明
hwnd	HWND	inoptional	ドラッグイメージの取得に使用するウィンドウのハンドル。この値は NULL にできます。詳細については「解説」を参照してください。
pdata	IDataObject*	in	ドラッグされるデータを含むデータオブジェクトの IDataObject インターフェイスへのポインター。
pdsrc	IDropSource*	inoptional	IDropSource インターフェイスの実装へのポインター。これはドラッグ操作中にソースと通信するために使用されます。 Windows Vista 以降では、この値が NULL の場合、シェルが代わりにドロップソースオブジェクトを作成します。
dwEffect	DROPEFFECT	in	ドラッグアンドドロップ操作でソースが許可する効果。最も重要な効果は、ドラッグアンドドロップ操作が移動を許可するかどうかです。指定可能な値の一覧については、DROPEFFECT を参照してください。
pdwEffect	DROPEFFECT*	out	ドラッグアンドドロップ操作がソースデータにどのように影響したかを示す値へのポインター。pdwEffect パラメーターは、操作がキャンセルされなかった場合にのみ設定されます。指定可能な値の一覧については、DROPEFFECT を参照してください。

戻り値の型: HRESULT

公式ドキュメント

ドラッグアンドドロップ操作を実行します。必要に応じたドラッグソースの作成や、ドラッグイメージをサポートします。

戻り値

型: HRESULT

この関数は、標準の戻り値 E_OUTOFMEMORY に加えて、次の値をサポートします。

戻り値	説明
DRAGDROP_S_DROP	ドラッグアンドドロップ操作が成功しました。
DRAGDROP_S_CANCEL	ドラッグアンドドロップ操作がキャンセルされました。
E_UNSPEC	予期しないエラーが発生しました。

解説(Remarks)

Windows Vista 以降では、データオブジェクト pdtobj にドラッグイメージがまだ格納されておらず、かつ hwnd で指定されたウィンドウからドラッグイメージを取得できない場合、シェルは汎用的なドラッグイメージを提供します。指定されたウィンドウからドラッグイメージを取得できない原因としては、hwnd が NULL であるか、指定されたウィンドウが DI_GETDRAGIMAGE メッセージをサポートしていないことが考えられます。

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

各言語での呼び出し定義

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

HRESULT SHDoDragDrop(
    HWND hwnd,   // optional
    IDataObject* pdata,
    IDropSource* pdsrc,   // optional
    DROPEFFECT dwEffect,
    DROPEFFECT* pdwEffect
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHDoDragDrop(
    IntPtr hwnd,   // HWND optional
    IntPtr pdata,   // IDataObject*
    IntPtr pdsrc,   // IDropSource* optional
    uint dwEffect,   // DROPEFFECT
    out uint pdwEffect   // DROPEFFECT* out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHDoDragDrop(
    hwnd As IntPtr,   ' HWND optional
    pdata As IntPtr,   ' IDataObject*
    pdsrc As IntPtr,   ' IDropSource* optional
    dwEffect As UInteger,   ' DROPEFFECT
    <Out> ByRef pdwEffect As UInteger   ' DROPEFFECT* out
) As Integer
End Function

' hwnd : HWND optional
' pdata : IDataObject*
' pdsrc : IDropSource* optional
' dwEffect : DROPEFFECT
' pdwEffect : DROPEFFECT* out
Declare PtrSafe Function SHDoDragDrop Lib "shell32" ( _
    ByVal hwnd As LongPtr, _
    ByVal pdata As LongPtr, _
    ByVal pdsrc As LongPtr, _
    ByVal dwEffect As Long, _
    ByRef pdwEffect As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHDoDragDrop = ctypes.windll.shell32.SHDoDragDrop
SHDoDragDrop.restype = ctypes.c_int
SHDoDragDrop.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND optional
    ctypes.c_void_p,  # pdata : IDataObject*
    ctypes.c_void_p,  # pdsrc : IDropSource* optional
    wintypes.DWORD,  # dwEffect : DROPEFFECT
    ctypes.c_void_p,  # pdwEffect : DROPEFFECT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHDoDragDrop = Fiddle::Function.new(
  lib['SHDoDragDrop'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND optional
    Fiddle::TYPE_VOIDP,  # pdata : IDataObject*
    Fiddle::TYPE_VOIDP,  # pdsrc : IDropSource* optional
    -Fiddle::TYPE_INT,  # dwEffect : DROPEFFECT
    Fiddle::TYPE_VOIDP,  # pdwEffect : DROPEFFECT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHDoDragDrop(
        hwnd: *mut core::ffi::c_void,  // HWND optional
        pdata: *mut core::ffi::c_void,  // IDataObject*
        pdsrc: *mut core::ffi::c_void,  // IDropSource* optional
        dwEffect: u32,  // DROPEFFECT
        pdwEffect: *mut u32  // DROPEFFECT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHDoDragDrop(IntPtr hwnd, IntPtr pdata, IntPtr pdsrc, uint dwEffect, out uint pdwEffect);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHDoDragDrop' -Namespace Win32 -PassThru
# $api::SHDoDragDrop(hwnd, pdata, pdsrc, dwEffect, pdwEffect)

#uselib "SHELL32.dll"
#func global SHDoDragDrop "SHDoDragDrop" sptr, sptr, sptr, sptr, sptr
; SHDoDragDrop hwnd, pdata, pdsrc, dwEffect, varptr(pdwEffect)   ; 戻り値は stat
; hwnd : HWND optional -> "sptr"
; pdata : IDataObject* -> "sptr"
; pdsrc : IDropSource* optional -> "sptr"
; dwEffect : DROPEFFECT -> "sptr"
; pdwEffect : DROPEFFECT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHDoDragDrop "SHDoDragDrop" sptr, sptr, sptr, int, var
; res = SHDoDragDrop(hwnd, pdata, pdsrc, dwEffect, pdwEffect)
; hwnd : HWND optional -> "sptr"
; pdata : IDataObject* -> "sptr"
; pdsrc : IDropSource* optional -> "sptr"
; dwEffect : DROPEFFECT -> "int"
; pdwEffect : DROPEFFECT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHDoDragDrop "SHDoDragDrop" sptr, sptr, sptr, int, sptr
; res = SHDoDragDrop(hwnd, pdata, pdsrc, dwEffect, varptr(pdwEffect))
; hwnd : HWND optional -> "sptr"
; pdata : IDataObject* -> "sptr"
; pdsrc : IDropSource* optional -> "sptr"
; dwEffect : DROPEFFECT -> "int"
; pdwEffect : DROPEFFECT* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。