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

ImageList_GetDragImage

関数
現在のドラッグ画像リストとその位置を取得する。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HIMAGELIST ImageList_GetDragImage(
    POINT* ppt,   // optional
    POINT* pptHotspot   // optional
);

パラメーター

名前方向説明
pptPOINT*outoptional現在のドラッグ位置を受け取る POINT 構造体へのポインターです。NULL を指定できます。
pptHotspotPOINT*outoptionalドラッグ位置を基準としたドラッグイメージのオフセットを受け取る POINT 構造体へのポインターです。NULL を指定できます。

戻り値の型: HIMAGELIST

公式ドキュメント

ドラッグイメージに使用される一時的なイメージリストを取得します。この関数は、現在のドラッグ位置と、ドラッグ位置を基準としたドラッグイメージのオフセットも取得します。

戻り値

型: HIMAGELIST

成功した場合はイメージリストへのハンドルを返します。失敗した場合は NULL を返します。

解説(Remarks)

一時的なイメージリストは、ImageList_EndDrag 関数が呼び出されたときに破棄されます。ドラッグ操作を開始するには、ImageList_BeginDrag 関数を使用してください。

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

各言語での呼び出し定義

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

HIMAGELIST ImageList_GetDragImage(
    POINT* ppt,   // optional
    POINT* pptHotspot   // optional
);
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern IntPtr ImageList_GetDragImage(
    IntPtr ppt,   // POINT* optional, out
    IntPtr pptHotspot   // POINT* optional, out
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function ImageList_GetDragImage(
    ppt As IntPtr,   ' POINT* optional, out
    pptHotspot As IntPtr   ' POINT* optional, out
) As IntPtr
End Function
' ppt : POINT* optional, out
' pptHotspot : POINT* optional, out
Declare PtrSafe Function ImageList_GetDragImage Lib "comctl32" ( _
    ByVal ppt As LongPtr, _
    ByVal pptHotspot As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ImageList_GetDragImage = ctypes.windll.comctl32.ImageList_GetDragImage
ImageList_GetDragImage.restype = ctypes.c_ssize_t
ImageList_GetDragImage.argtypes = [
    ctypes.c_void_p,  # ppt : POINT* optional, out
    ctypes.c_void_p,  # pptHotspot : POINT* optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procImageList_GetDragImage = comctl32.NewProc("ImageList_GetDragImage")
)

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

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

typedef ImageList_GetDragImageNative = IntPtr Function(Pointer<Void>, Pointer<Void>);
typedef ImageList_GetDragImageDart = int Function(Pointer<Void>, Pointer<Void>);
final ImageList_GetDragImage = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<ImageList_GetDragImageNative, ImageList_GetDragImageDart>('ImageList_GetDragImage');
// ppt : POINT* optional, out -> Pointer<Void>
// pptHotspot : POINT* optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImageList_GetDragImage(
  ppt: Pointer;   // POINT* optional, out
  pptHotspot: Pointer   // POINT* optional, out
): NativeInt; stdcall;
  external 'COMCTL32.dll' name 'ImageList_GetDragImage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImageList_GetDragImage"
  c_ImageList_GetDragImage :: Ptr () -> Ptr () -> IO CIntPtr
-- ppt : POINT* optional, out -> Ptr ()
-- pptHotspot : POINT* optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let imagelist_getdragimage =
  foreign "ImageList_GetDragImage"
    ((ptr void) @-> (ptr void) @-> returning intptr_t)
(* ppt : POINT* optional, out -> (ptr void) *)
(* pptHotspot : POINT* optional, out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("ImageList_GetDragImage" image-list-get-drag-image :convention :stdcall) :int64
  (ppt :pointer)   ; POINT* optional, out
  (ppt-hotspot :pointer))   ; POINT* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImageList_GetDragImage = Win32::API::More->new('COMCTL32',
    'LPARAM ImageList_GetDragImage(LPVOID ppt, LPVOID pptHotspot)');
# my $ret = $ImageList_GetDragImage->Call($ppt, $pptHotspot);
# ppt : POINT* optional, out -> LPVOID
# pptHotspot : POINT* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型