DragQueryFileA

関数

ドロップされたファイル名(ANSI)や個数を取得する。

DLLSHELL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

DWORD DragQueryFileA(
    HDROP hDrop,
    DWORD iFile,
    LPSTR lpszFile,   // optional
    DWORD cch
);

パラメーター

名前	型	方向	説明
hDrop	HDROP	in	ドロップされたファイルのファイル名を含む構造体の識別子です。
iFile	DWORD	in	照会するファイルのインデックスです。このパラメーターの値が 0xFFFFFFFF の場合、DragQueryFile はドロップされたファイルの数を返します。このパラメーターの値が 0 からドロップされたファイルの総数までの範囲にある場合、DragQueryFile は対応する値を持つファイル名を lpszFile パラメーターが指すバッファーにコピーします。
lpszFile	LPSTR	outoptional	関数が戻るときに、ドロップされたファイルのファイル名を受け取るバッファーのアドレスです。このファイル名は null で終わる文字列です。このパラメーターが NULL の場合、DragQueryFile はこのバッファーに必要なサイズを文字数で返します。
cch	DWORD	in	lpszFile バッファーのサイズ(文字数)です。

戻り値の型: DWORD

公式ドキュメント

ドラッグアンドドロップ操作が成功した結果としてドロップされたファイルの名前を取得します。(ANSI)

戻り値

型: UINT

0 以外の値は、呼び出しが成功したことを示します。

関数がファイル名をバッファーにコピーする場合、戻り値はコピーされた文字数であり、終端の null 文字は含まれません。

インデックス値が 0xFFFFFFFF の場合、戻り値はドロップされたファイルの数です。インデックス変数自体は変更されずに返されるため、0xFFFFFFFF のままになることに注意してください。

インデックス値が 0 からドロップされたファイルの総数までの範囲にあり、lpszFile バッファーのアドレスが NULL の場合、戻り値はバッファーに必要なサイズ(文字数)であり、終端の null 文字は含まれません。

解説(Remarks)

メモ

shellapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして DragQueryFile を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在させて使用すると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

DWORD DragQueryFileA(
    HDROP hDrop,
    DWORD iFile,
    LPSTR lpszFile,   // optional
    DWORD cch
);

[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint DragQueryFileA(
    IntPtr hDrop,   // HDROP
    uint iFile,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszFile,   // LPSTR optional, out
    uint cch   // DWORD
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DragQueryFileA(
    hDrop As IntPtr,   ' HDROP
    iFile As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszFile As System.Text.StringBuilder,   ' LPSTR optional, out
    cch As UInteger   ' DWORD
) As UInteger
End Function

' hDrop : HDROP
' iFile : DWORD
' lpszFile : LPSTR optional, out
' cch : DWORD
Declare PtrSafe Function DragQueryFileA Lib "shell32" ( _
    ByVal hDrop As LongPtr, _
    ByVal iFile As Long, _
    ByVal lpszFile As String, _
    ByVal cch As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DragQueryFileA = ctypes.windll.shell32.DragQueryFileA
DragQueryFileA.restype = wintypes.DWORD
DragQueryFileA.argtypes = [
    wintypes.HANDLE,  # hDrop : HDROP
    wintypes.DWORD,  # iFile : DWORD
    wintypes.LPSTR,  # lpszFile : LPSTR optional, out
    wintypes.DWORD,  # cch : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
DragQueryFileA = Fiddle::Function.new(
  lib['DragQueryFileA'],
  [
    Fiddle::TYPE_VOIDP,  # hDrop : HDROP
    -Fiddle::TYPE_INT,  # iFile : DWORD
    Fiddle::TYPE_VOIDP,  # lpszFile : LPSTR optional, out
    -Fiddle::TYPE_INT,  # cch : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn DragQueryFileA(
        hDrop: *mut core::ffi::c_void,  // HDROP
        iFile: u32,  // DWORD
        lpszFile: *mut u8,  // LPSTR optional, out
        cch: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi)]
public static extern uint DragQueryFileA(IntPtr hDrop, uint iFile, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszFile, uint cch);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_DragQueryFileA' -Namespace Win32 -PassThru
# $api::DragQueryFileA(hDrop, iFile, lpszFile, cch)

#uselib "SHELL32.dll"
#func global DragQueryFileA "DragQueryFileA" sptr, sptr, sptr, sptr
; DragQueryFileA hDrop, iFile, varptr(lpszFile), cch   ; 戻り値は stat
; hDrop : HDROP -> "sptr"
; iFile : DWORD -> "sptr"
; lpszFile : LPSTR optional, out -> "sptr"
; cch : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global DragQueryFileA "DragQueryFileA" sptr, int, var, int
; res = DragQueryFileA(hDrop, iFile, lpszFile, cch)
; hDrop : HDROP -> "sptr"
; iFile : DWORD -> "int"
; lpszFile : LPSTR optional, out -> "var"
; cch : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global DragQueryFileA "DragQueryFileA" sptr, int, sptr, int
; res = DragQueryFileA(hDrop, iFile, varptr(lpszFile), cch)
; hDrop : HDROP -> "sptr"
; iFile : DWORD -> "int"
; lpszFile : LPSTR optional, out -> "sptr"
; cch : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。