ホーム › System.Diagnostics.Debug › EnumDirTree

EnumDirTree

関数

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

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

シグネチャ

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

BOOL EnumDirTree(
    HANDLE hProcess,   // optional
    LPCSTR RootPath,
    LPCSTR InputPathName,
    LPSTR OutputPathBuffer,   // optional
    PENUMDIRTREE_CALLBACK cb,   // optional
    void* data   // optional
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

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

各言語での呼び出し定義

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

BOOL EnumDirTree(
    HANDLE hProcess,   // optional
    LPCSTR RootPath,
    LPCSTR InputPathName,
    LPSTR OutputPathBuffer,   // optional
    PENUMDIRTREE_CALLBACK cb,   // optional
    void* data   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool EnumDirTree(
    IntPtr hProcess,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPStr)] string RootPath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string InputPathName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder OutputPathBuffer,   // LPSTR optional, out
    IntPtr cb,   // PENUMDIRTREE_CALLBACK optional
    IntPtr data   // void* optional
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumDirTree(
    hProcess As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPStr)> RootPath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> InputPathName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> OutputPathBuffer As System.Text.StringBuilder,   ' LPSTR optional, out
    cb As IntPtr,   ' PENUMDIRTREE_CALLBACK optional
    data As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE optional
' RootPath : LPCSTR
' InputPathName : LPCSTR
' OutputPathBuffer : LPSTR optional, out
' cb : PENUMDIRTREE_CALLBACK optional
' data : void* optional
Declare PtrSafe Function EnumDirTree Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal RootPath As String, _
    ByVal InputPathName As String, _
    ByVal OutputPathBuffer As String, _
    ByVal cb As LongPtr, _
    ByVal data As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EnumDirTree = ctypes.windll.dbghelp.EnumDirTree
EnumDirTree.restype = wintypes.BOOL
EnumDirTree.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE optional
    wintypes.LPCSTR,  # RootPath : LPCSTR
    wintypes.LPCSTR,  # InputPathName : LPCSTR
    wintypes.LPSTR,  # OutputPathBuffer : LPSTR optional, out
    ctypes.c_void_p,  # cb : PENUMDIRTREE_CALLBACK 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')
EnumDirTree = Fiddle::Function.new(
  lib['EnumDirTree'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE optional
    Fiddle::TYPE_VOIDP,  # RootPath : LPCSTR
    Fiddle::TYPE_VOIDP,  # InputPathName : LPCSTR
    Fiddle::TYPE_VOIDP,  # OutputPathBuffer : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # cb : PENUMDIRTREE_CALLBACK optional
    Fiddle::TYPE_VOIDP,  # data : void* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn EnumDirTree(
        hProcess: *mut core::ffi::c_void,  // HANDLE optional
        RootPath: *const u8,  // LPCSTR
        InputPathName: *const u8,  // LPCSTR
        OutputPathBuffer: *mut u8,  // LPSTR optional, out
        cb: *const core::ffi::c_void,  // PENUMDIRTREE_CALLBACK 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.Ansi, SetLastError = true)]
public static extern bool EnumDirTree(IntPtr hProcess, [MarshalAs(UnmanagedType.LPStr)] string RootPath, [MarshalAs(UnmanagedType.LPStr)] string InputPathName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder OutputPathBuffer, IntPtr cb, IntPtr data);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_EnumDirTree' -Namespace Win32 -PassThru
# $api::EnumDirTree(hProcess, RootPath, InputPathName, OutputPathBuffer, cb, data)

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

出力引数:

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