ホーム › System.Diagnostics.Debug › EnumDirTreeW

EnumDirTreeW

関数

ディレクトリツリーを列挙し一致ファイルをコールバックへ通知する。

DLLdbghelp.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

BOOL EnumDirTreeW(
    HANDLE hProcess,   // optional
    LPCWSTR RootPath,
    LPCWSTR InputPathName,
    LPWSTR OutputPathBuffer,   // optional
    PENUMDIRTREE_CALLBACKW cb,   // optional
    void* data   // optional
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	inoptional	プロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
RootPath	LPCWSTR	in	関数がファイルの検索を開始するパス。
InputPathName	LPCWSTR	in	検索対象のファイル名。部分的なパスを指定することもできます。
OutputPathBuffer	LPWSTR	outoptional	ファイルの完全なパスを受け取るバッファーへのポインター。関数が失敗した場合、または一致するファイルが見つからなかった場合でも、このバッファーには最後に見つかった完全なパスが格納されます。このパラメーターは省略可能であり、NULL を指定できます。
cb	PENUMDIRTREE_CALLBACKW	inoptional	アプリケーション定義のコールバック関数、または NULL。詳細については、 EnumDirTreeProc を参照してください。
data	void*	inoptional	ユーザー定義のデータ、または NULL。この値はコールバック関数に渡されます。

戻り値の型: BOOL

公式ドキュメント

EnumDirTreeW (Unicode) 関数は、指定したディレクトリツリー内で指定したファイルが出現する箇所をすべて列挙します。

戻り値

関数が成功した場合、戻り値は TRUE です。

関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

SymRegisterCallbackProc64 コールバック関数を登録すると、検索をキャンセルできます。ファイル操作のたびに、 EnumDirTree はこのコールバック関数を CBA_DEFERRED_SYMBOL_LOAD_CANCEL を指定して呼び出します。コールバック関数が TRUE を返すと、 EnumDirTree は検索をキャンセルします。

この関数を含むすべての DbgHelp 関数はシングルスレッドです。そのため、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損が発生する可能性が高くなります。これを回避するには、複数のスレッドからこの関数への同時呼び出しをすべて同期する必要があります。

この関数の Unicode バージョンを呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義してください。

メモ

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

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

各言語での呼び出し定義

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

BOOL EnumDirTreeW(
    HANDLE hProcess,   // optional
    LPCWSTR RootPath,
    LPCWSTR InputPathName,
    LPWSTR OutputPathBuffer,   // optional
    PENUMDIRTREE_CALLBACKW cb,   // optional
    void* data   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool EnumDirTreeW(
    IntPtr hProcess,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string RootPath,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string InputPathName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder OutputPathBuffer,   // LPWSTR optional, out
    IntPtr cb,   // PENUMDIRTREE_CALLBACKW optional
    IntPtr data   // void* optional
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumDirTreeW(
    hProcess As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPWStr)> RootPath As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> InputPathName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> OutputPathBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    cb As IntPtr,   ' PENUMDIRTREE_CALLBACKW optional
    data As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE optional
' RootPath : LPCWSTR
' InputPathName : LPCWSTR
' OutputPathBuffer : LPWSTR optional, out
' cb : PENUMDIRTREE_CALLBACKW optional
' data : void* optional
Declare PtrSafe Function EnumDirTreeW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal RootPath As LongPtr, _
    ByVal InputPathName As LongPtr, _
    ByVal OutputPathBuffer As LongPtr, _
    ByVal cb As LongPtr, _
    ByVal data As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EnumDirTreeW = ctypes.windll.dbghelp.EnumDirTreeW
EnumDirTreeW.restype = wintypes.BOOL
EnumDirTreeW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE optional
    wintypes.LPCWSTR,  # RootPath : LPCWSTR
    wintypes.LPCWSTR,  # InputPathName : LPCWSTR
    wintypes.LPWSTR,  # OutputPathBuffer : LPWSTR optional, out
    ctypes.c_void_p,  # cb : PENUMDIRTREE_CALLBACKW optional
    ctypes.POINTER(None),  # data : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
EnumDirTreeW = Fiddle::Function.new(
  lib['EnumDirTreeW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE optional
    Fiddle::TYPE_VOIDP,  # RootPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # InputPathName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # OutputPathBuffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # cb : PENUMDIRTREE_CALLBACKW optional
    Fiddle::TYPE_VOIDP,  # data : void* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "dbghelp")]
extern "system" {
    fn EnumDirTreeW(
        hProcess: *mut core::ffi::c_void,  // HANDLE optional
        RootPath: *const u16,  // LPCWSTR
        InputPathName: *const u16,  // LPCWSTR
        OutputPathBuffer: *mut u16,  // LPWSTR optional, out
        cb: *const core::ffi::c_void,  // PENUMDIRTREE_CALLBACKW optional
        data: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool EnumDirTreeW(IntPtr hProcess, [MarshalAs(UnmanagedType.LPWStr)] string RootPath, [MarshalAs(UnmanagedType.LPWStr)] string InputPathName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder OutputPathBuffer, IntPtr cb, IntPtr data);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_EnumDirTreeW' -Namespace Win32 -PassThru
# $api::EnumDirTreeW(hProcess, RootPath, InputPathName, OutputPathBuffer, cb, data)

#uselib "dbghelp.dll"
#func global EnumDirTreeW "EnumDirTreeW" wptr, wptr, wptr, wptr, wptr, wptr
; EnumDirTreeW hProcess, RootPath, InputPathName, varptr(OutputPathBuffer), cb, data   ; 戻り値は stat
; hProcess : HANDLE optional -> "wptr"
; RootPath : LPCWSTR -> "wptr"
; InputPathName : LPCWSTR -> "wptr"
; OutputPathBuffer : LPWSTR optional, out -> "wptr"
; cb : PENUMDIRTREE_CALLBACKW optional -> "wptr"
; data : void* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global EnumDirTreeW "EnumDirTreeW" sptr, wstr, wstr, var, sptr, sptr
; res = EnumDirTreeW(hProcess, RootPath, InputPathName, OutputPathBuffer, cb, data)
; hProcess : HANDLE optional -> "sptr"
; RootPath : LPCWSTR -> "wstr"
; InputPathName : LPCWSTR -> "wstr"
; OutputPathBuffer : LPWSTR optional, out -> "var"
; cb : PENUMDIRTREE_CALLBACKW optional -> "sptr"
; data : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dbghelp.dll"
#cfunc global EnumDirTreeW "EnumDirTreeW" sptr, wstr, wstr, sptr, sptr, sptr
; res = EnumDirTreeW(hProcess, RootPath, InputPathName, varptr(OutputPathBuffer), cb, data)
; hProcess : HANDLE optional -> "sptr"
; RootPath : LPCWSTR -> "wstr"
; InputPathName : LPCWSTR -> "wstr"
; OutputPathBuffer : LPWSTR optional, out -> "sptr"
; cb : PENUMDIRTREE_CALLBACKW optional -> "sptr"
; data : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。