DragQueryFileA 関数 (shellapi.h)

  • [アーティクル]

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

構文

UINT DragQueryFileA(
  [in]  HDROP hDrop,
  [in]  UINT  iFile,
  [out] LPSTR lpszFile,
        UINT  cch
);

パラメーター

[in] hDrop

種類: HDROP

ドロップされたファイルのファイル名を含む構造体の識別子。

[in] iFile

型: UINT

クエリを実行するファイルのインデックス。 このパラメーターの値が0xFFFFFFFF場合、 DragQueryFile は削除されたファイルの数を返します。 このパラメーターの値が 0 からドロップされたファイルの合計数の間にある場合、 DragQueryFile は、対応する値を持つファイル名を lpszFile パラメーターが指すバッファーにコピーします。

[out] lpszFile

種類: LPTSTR

関数が戻るときにドロップされたファイルのファイル名を受け取るバッファーのアドレス。 このファイル名は null で終わる文字列です。 このパラメーターが NULL の場合、 DragQueryFile は、このバッファーの必要なサイズを文字数で返します。

cch

型: UINT

lpszFile バッファーのサイズ (文字数)。

戻り値

型: UINT

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

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

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

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

注釈

注意

shellapi.h ヘッダーは、DragQueryFile をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー shellapi.h
Library Shell32.lib
[DLL] Shell32.dll (バージョン 4.0 以降)
API セット ext-ms-win-shell-shell32-l1-2-1 (Windows 10 バージョン 10.0.10240 で導入)

こちらもご覧ください

DragQueryPoint