ホーム › System.Diagnostics.Debug › SearchTreeForFile

SearchTreeForFile

関数

ディレクトリツリーを再帰的に検索して指定ファイルを探す。

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

シグネチャ

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

BOOL SearchTreeForFile(
    LPCSTR RootPath,
    LPCSTR InputPathName,
    LPSTR OutputPathBuffer
);

パラメーター

名前	型	方向	説明
RootPath	LPCSTR	in	関数がファイルの検索を開始するパス。
InputPathName	LPCSTR	in	関数が検索するファイル。部分的なパスを使用できます。
OutputPathBuffer	LPSTR	out	見つかったファイルへのフルパスを受け取るバッファへのポインター。戻り値が FALSE の場合、この文字列は変更されません。

戻り値の型: BOOL

公式ドキュメント

SearchTreeForFile 関数 (dbghelp.h) は、指定されたファイルをディレクトリツリー内で検索します。

戻り値

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

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

解説(Remarks)

この関数は、RootPath パラメーターで指定されたパスを起点として、InputPathName パラメーターで指定されたファイルを検索します。RootPath で許可される最大のパス深度は 32 ディレクトリです。ディレクトリツリー内でファイルが見つかると、関数は OutputPathBuffer パラメーターで指定されたバッファにファイルへのフルパスを格納します。サブディレクトリの検索順序は、基盤となるファイルシステムによって決定されます。

SymRegisterCallbackProc64 コールバック関数を登録すると、検索をキャンセルできます。検索される各ディレクトリについて、 SearchTreeForFile はこのコールバック関数を CBA_DEFERRED_SYMBOL_LOAD_CANCEL とともに呼び出します。コールバック関数が TRUE を返すと、 SearchTreeForFile は検索をキャンセルします。

この関数は、検索されるディレクトリごとに 1 つの CBA_DEFERRED_SYMBOL_LOAD_CANCEL イベントを発生させます。これにより、呼び出し元は検索をキャンセルできます。

この関数を含むすべての 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 SearchTreeForFile(
    LPCSTR RootPath,
    LPCSTR InputPathName,
    LPSTR OutputPathBuffer
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SearchTreeForFile(
    [MarshalAs(UnmanagedType.LPStr)] string RootPath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string InputPathName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder OutputPathBuffer   // LPSTR out
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SearchTreeForFile(
    <MarshalAs(UnmanagedType.LPStr)> RootPath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> InputPathName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> OutputPathBuffer As System.Text.StringBuilder   ' LPSTR out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' RootPath : LPCSTR
' InputPathName : LPCSTR
' OutputPathBuffer : LPSTR out
Declare PtrSafe Function SearchTreeForFile Lib "dbghelp" ( _
    ByVal RootPath As String, _
    ByVal InputPathName As String, _
    ByVal OutputPathBuffer As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SearchTreeForFile = ctypes.windll.dbghelp.SearchTreeForFile
SearchTreeForFile.restype = wintypes.BOOL
SearchTreeForFile.argtypes = [
    wintypes.LPCSTR,  # RootPath : LPCSTR
    wintypes.LPCSTR,  # InputPathName : LPCSTR
    wintypes.LPSTR,  # OutputPathBuffer : LPSTR out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SearchTreeForFile = Fiddle::Function.new(
  lib['SearchTreeForFile'],
  [
    Fiddle::TYPE_VOIDP,  # RootPath : LPCSTR
    Fiddle::TYPE_VOIDP,  # InputPathName : LPCSTR
    Fiddle::TYPE_VOIDP,  # OutputPathBuffer : LPSTR out
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SearchTreeForFile(
        RootPath: *const u8,  // LPCSTR
        InputPathName: *const u8,  // LPCSTR
        OutputPathBuffer: *mut u8  // LPSTR out
    ) -> 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 SearchTreeForFile([MarshalAs(UnmanagedType.LPStr)] string RootPath, [MarshalAs(UnmanagedType.LPStr)] string InputPathName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder OutputPathBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SearchTreeForFile' -Namespace Win32 -PassThru
# $api::SearchTreeForFile(RootPath, InputPathName, OutputPathBuffer)

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

出力引数:

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