Win32 API 日本語リファレンス
ホームUI.Shell › DAD_SetDragImage

DAD_SetDragImage

関数
ドラッグ&ドロップで表示するドラッグ画像を設定する。
DLLSHELL32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL DAD_SetDragImage(
    HIMAGELIST him,
    POINT* pptOffset
);

パラメーター

名前方向説明
himHIMAGELISTinイメージリストへのハンドルです。このパラメーターは ImageList のインデックス 0 を使用します。
pptOffsetPOINT*inoutイメージをドラッグする際のホットスポットとして使用される座標へのポインターです。座標はイメージの左上隅を基準とします。

戻り値の型: BOOL

公式ドキュメント

ドラッグイメージを設定します。

戻り値

型: BOOL

成功した場合は 0 以外、それ以外の場合は 0 を返します。

解説(Remarks)

him パラメーターに -1 を、pptOffset パラメーターに NULL を設定することで、ドラッグイメージをクリアできます。イメージは同一スレッド内で設定されている必要があります。

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

各言語での呼び出し定義

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

BOOL DAD_SetDragImage(
    HIMAGELIST him,
    POINT* pptOffset
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern bool DAD_SetDragImage(
    IntPtr him,   // HIMAGELIST
    IntPtr pptOffset   // POINT* in/out
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function DAD_SetDragImage(
    him As IntPtr,   ' HIMAGELIST
    pptOffset As IntPtr   ' POINT* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' him : HIMAGELIST
' pptOffset : POINT* in/out
Declare PtrSafe Function DAD_SetDragImage Lib "shell32" ( _
    ByVal him As LongPtr, _
    ByVal pptOffset As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DAD_SetDragImage = ctypes.windll.shell32.DAD_SetDragImage
DAD_SetDragImage.restype = wintypes.BOOL
DAD_SetDragImage.argtypes = [
    ctypes.c_ssize_t,  # him : HIMAGELIST
    ctypes.c_void_p,  # pptOffset : POINT* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
DAD_SetDragImage = Fiddle::Function.new(
  lib['DAD_SetDragImage'],
  [
    Fiddle::TYPE_INTPTR_T,  # him : HIMAGELIST
    Fiddle::TYPE_VOIDP,  # pptOffset : POINT* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn DAD_SetDragImage(
        him: isize,  // HIMAGELIST
        pptOffset: *mut POINT  // POINT* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll")]
public static extern bool DAD_SetDragImage(IntPtr him, IntPtr pptOffset);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_DAD_SetDragImage' -Namespace Win32 -PassThru
# $api::DAD_SetDragImage(him, pptOffset)
#uselib "SHELL32.dll"
#func global DAD_SetDragImage "DAD_SetDragImage" sptr, sptr
; DAD_SetDragImage him, varptr(pptOffset)   ; 戻り値は stat
; him : HIMAGELIST -> "sptr"
; pptOffset : POINT* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global DAD_SetDragImage "DAD_SetDragImage" sptr, var
; res = DAD_SetDragImage(him, pptOffset)
; him : HIMAGELIST -> "sptr"
; pptOffset : POINT* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL DAD_SetDragImage(HIMAGELIST him, POINT* pptOffset)
#uselib "SHELL32.dll"
#cfunc global DAD_SetDragImage "DAD_SetDragImage" intptr, var
; res = DAD_SetDragImage(him, pptOffset)
; him : HIMAGELIST -> "intptr"
; pptOffset : POINT* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procDAD_SetDragImage = shell32.NewProc("DAD_SetDragImage")
)

// him (HIMAGELIST), pptOffset (POINT* in/out)
r1, _, err := procDAD_SetDragImage.Call(
	uintptr(him),
	uintptr(pptOffset),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function DAD_SetDragImage(
  him: NativeInt;   // HIMAGELIST
  pptOffset: Pointer   // POINT* in/out
): BOOL; stdcall;
  external 'SHELL32.dll' name 'DAD_SetDragImage';
result := DllCall("SHELL32\DAD_SetDragImage"
    , "Ptr", him   ; HIMAGELIST
    , "Ptr", pptOffset   ; POINT* in/out
    , "Int")   ; return: BOOL
●DAD_SetDragImage(him, pptOffset) = DLL("SHELL32.dll", "bool DAD_SetDragImage(int, void*)")
# 呼び出し: DAD_SetDragImage(him, pptOffset)
# him : HIMAGELIST -> "int"
# pptOffset : POINT* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn DAD_SetDragImage(
    him: isize, // HIMAGELIST
    pptOffset: [*c]POINT // POINT* in/out
) callconv(std.os.windows.WINAPI) i32;
proc DAD_SetDragImage(
    him: int,  # HIMAGELIST
    pptOffset: ptr POINT  # POINT* in/out
): int32 {.importc: "DAD_SetDragImage", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int DAD_SetDragImage(
    ptrdiff_t him,   // HIMAGELIST
    POINT* pptOffset   // POINT* in/out
);
ccall((:DAD_SetDragImage, "SHELL32.dll"), stdcall, Int32,
      (Int, Ptr{POINT}),
      him, pptOffset)
# him : HIMAGELIST -> Int
# pptOffset : POINT* in/out -> Ptr{POINT}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DAD_SetDragImage(
    intptr_t him,
    void* pptOffset);
]]
local shell32 = ffi.load("shell32")
-- shell32.DAD_SetDragImage(him, pptOffset)
-- him : HIMAGELIST
-- pptOffset : POINT* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const DAD_SetDragImage = lib.func('__stdcall', 'DAD_SetDragImage', 'int32_t', ['intptr_t', 'void *']);
// DAD_SetDragImage(him, pptOffset)
// him : HIMAGELIST -> 'intptr_t'
// pptOffset : POINT* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  DAD_SetDragImage: { parameters: ["isize", "pointer"], result: "i32" },
});
// lib.symbols.DAD_SetDragImage(him, pptOffset)
// him : HIMAGELIST -> "isize"
// pptOffset : POINT* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DAD_SetDragImage(
    intptr_t him,
    void* pptOffset);
C, "SHELL32.dll");
// $ffi->DAD_SetDragImage(him, pptOffset);
// him : HIMAGELIST
// pptOffset : POINT* 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 Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class);
    boolean DAD_SetDragImage(
        long him,   // HIMAGELIST
        Pointer pptOffset   // POINT* in/out
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun DAD_SetDragImage = DAD_SetDragImage(
    him : LibC::SSizeT,   # HIMAGELIST
    pptOffset : POINT*   # POINT* 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 DAD_SetDragImageNative = Int32 Function(IntPtr, Pointer<Void>);
typedef DAD_SetDragImageDart = int Function(int, Pointer<Void>);
final DAD_SetDragImage = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<DAD_SetDragImageNative, DAD_SetDragImageDart>('DAD_SetDragImage');
// him : HIMAGELIST -> IntPtr
// pptOffset : POINT* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DAD_SetDragImage(
  him: NativeInt;   // HIMAGELIST
  pptOffset: Pointer   // POINT* in/out
): BOOL; stdcall;
  external 'SHELL32.dll' name 'DAD_SetDragImage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DAD_SetDragImage"
  c_DAD_SetDragImage :: CIntPtr -> Ptr () -> IO CInt
-- him : HIMAGELIST -> CIntPtr
-- pptOffset : POINT* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dad_setdragimage =
  foreign "DAD_SetDragImage"
    (intptr_t @-> (ptr void) @-> returning int32_t)
(* him : HIMAGELIST -> intptr_t *)
(* pptOffset : POINT* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("DAD_SetDragImage" dad-set-drag-image :convention :stdcall) :int32
  (him :int64)   ; HIMAGELIST
  (ppt-offset :pointer))   ; POINT* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DAD_SetDragImage = Win32::API::More->new('SHELL32',
    'BOOL DAD_SetDragImage(LPARAM him, LPVOID pptOffset)');
# my $ret = $DAD_SetDragImage->Call($him, $pptOffset);
# him : HIMAGELIST -> LPARAM
# pptOffset : POINT* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型