DlgDirSelectExA

関数

リストボックスで選択中のファイルやディレクトリ名を取得する(ANSI版)。

DLLUSER32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL DlgDirSelectExA(
    HWND hwndDlg,
    LPSTR lpString,
    INT chCount,
    INT idListBox
);

パラメーター

名前	型	方向	説明
hwndDlg	HWND	in	リストボックスを含むダイアログボックスへのハンドル。
lpString	LPSTR	out	選択されたパスを受け取るバッファーへのポインター。
chCount	INT	in	lpString が指すバッファーの長さ( TCHAR 単位)。
idListBox	INT	in	ダイアログボックス内のリストボックスの識別子。

戻り値の型: BOOL

公式ドキュメント

単一選択リストボックスから現在の選択項目を取得します。リストボックスは DlgDirList 関数によって設定されており、選択項目がドライブ文字、ファイル名、またはディレクトリ名であることを前提とします。(ANSI)

戻り値

型: BOOL

現在の選択項目がディレクトリ名である場合、戻り値は 0 以外の値です。

現在の選択項目がディレクトリ名でない場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

DlgDirSelectEx 関数は、選択項目を lpString パラメーターが指すバッファーにコピーします。現在の選択項目がディレクトリ名またはドライブ文字である場合、DlgDirSelectEx は囲んでいる角かっこ(ドライブ文字の場合はハイフンも)を取り除き、その名前または文字をそのまま新しいパスに挿入できるようにします。選択項目がない場合、 lpString は変更されません。

文字列がバッファーと同じ長さかそれ以上の場合、バッファーには切り詰められた文字列と終端の null 文字が格納されます。

DlgDirSelectEx はリストボックスに LB_GETCURSEL および LB_GETTEXT メッセージを送信します。この関数は、リストボックスから複数のファイル名を返すことを許可しません。リストボックスは複数選択リストボックスであってはなりません。複数選択リストボックスである場合、この関数は 0 以外の値を返さず、 lpString は変更されません。

Windows 95 以降: DlgDirSelectExW は Microsoft Layer for Unicode によってサポートされています。これを使用するには、Microsoft Layer for Unicode on Windows Me/98/95 Systems で説明されているとおり、特定のファイルをアプリケーションに追加する必要があります。

Examples

例については、Creating a Directory Listing in a Single-selection List Box を参照してください。

メモ

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

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

各言語での呼び出し定義

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

BOOL DlgDirSelectExA(
    HWND hwndDlg,
    LPSTR lpString,
    INT chCount,
    INT idListBox
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool DlgDirSelectExA(
    IntPtr hwndDlg,   // HWND
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpString,   // LPSTR out
    int chCount,   // INT
    int idListBox   // INT
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DlgDirSelectExA(
    hwndDlg As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPStr)> lpString As System.Text.StringBuilder,   ' LPSTR out
    chCount As Integer,   ' INT
    idListBox As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hwndDlg : HWND
' lpString : LPSTR out
' chCount : INT
' idListBox : INT
Declare PtrSafe Function DlgDirSelectExA Lib "user32" ( _
    ByVal hwndDlg As LongPtr, _
    ByVal lpString As String, _
    ByVal chCount As Long, _
    ByVal idListBox As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DlgDirSelectExA = ctypes.windll.user32.DlgDirSelectExA
DlgDirSelectExA.restype = wintypes.BOOL
DlgDirSelectExA.argtypes = [
    wintypes.HANDLE,  # hwndDlg : HWND
    wintypes.LPSTR,  # lpString : LPSTR out
    ctypes.c_int,  # chCount : INT
    ctypes.c_int,  # idListBox : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DlgDirSelectExA = Fiddle::Function.new(
  lib['DlgDirSelectExA'],
  [
    Fiddle::TYPE_VOIDP,  # hwndDlg : HWND
    Fiddle::TYPE_VOIDP,  # lpString : LPSTR out
    Fiddle::TYPE_INT,  # chCount : INT
    Fiddle::TYPE_INT,  # idListBox : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn DlgDirSelectExA(
        hwndDlg: *mut core::ffi::c_void,  // HWND
        lpString: *mut u8,  // LPSTR out
        chCount: i32,  // INT
        idListBox: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool DlgDirSelectExA(IntPtr hwndDlg, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpString, int chCount, int idListBox);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DlgDirSelectExA' -Namespace Win32 -PassThru
# $api::DlgDirSelectExA(hwndDlg, lpString, chCount, idListBox)

#uselib "USER32.dll"
#func global DlgDirSelectExA "DlgDirSelectExA" sptr, sptr, sptr, sptr
; DlgDirSelectExA hwndDlg, varptr(lpString), chCount, idListBox   ; 戻り値は stat
; hwndDlg : HWND -> "sptr"
; lpString : LPSTR out -> "sptr"
; chCount : INT -> "sptr"
; idListBox : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global DlgDirSelectExA "DlgDirSelectExA" sptr, var, int, int
; res = DlgDirSelectExA(hwndDlg, lpString, chCount, idListBox)
; hwndDlg : HWND -> "sptr"
; lpString : LPSTR out -> "var"
; chCount : INT -> "int"
; idListBox : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global DlgDirSelectExA "DlgDirSelectExA" sptr, sptr, int, int
; res = DlgDirSelectExA(hwndDlg, varptr(lpString), chCount, idListBox)
; hwndDlg : HWND -> "sptr"
; lpString : LPSTR out -> "sptr"
; chCount : INT -> "int"
; idListBox : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。