Export (0) Print
Expand All
Expand Minimize

EnumDirTree function

Enumerates all occurrences of the specified file in the specified directory tree.

Syntax


BOOL WINAPI EnumDirTree(
  _In_opt_   HANDLE hProcess,
  _In_       PCTSTR RootPath,
  _In_       PCTSTR InputPathName,
  _Out_opt_  PTSTR OutputPathBuffer,
  _In_opt_   PENUMDIRTREE_CALLBACK Callback,
  _In_opt_   PVOID CallbackData
);

Parameters

hProcess [in, optional]

A handle to a process. This handle must have been previously passed to the SymInitialize function.

RootPath [in]

The path where the function should begin searching for the file.

InputPathName [in]

The name of the file to be found. You can specify a partial path.

OutputPathBuffer [out, optional]

A pointer to a buffer that receives the full path of the file. If the function fails or does not find a matching file, this buffer will still contain the last full path that was found.

This parameter is optional and can be NULL.

Callback [in, optional]

An application-defined callback function, or NULL. For more information, see EnumDirTreeProc.

CallbackData [in, optional]

The user-defined data or NULL. This value is passed to the callback function.

Return value

If the function succeeds, the return value is TRUE.

If the function fails, the return value is FALSE. To retrieve extended error information, call GetLastError.

Remarks

The search can be canceled if you register a SymRegisterCallbackProc64 callback function. For every file operation, EnumDirTree calls this callback function with CBA_DEFERRED_SYMBOL_LOAD_CANCEL. If the callback function returns TRUE, EnumDirTree cancels the search.

All DbgHelp functions, such as this one, are single threaded. Therefore, calls from more than one thread to this function will likely result in unexpected behavior or memory corruption. To avoid this, you must synchronize all concurrent calls from more than one thread to this function.

To call the Unicode version of this function, define DBGHELP_TRANSLATE_TCHAR.

Requirements

Redistributable

DbgHelp.dll 6.0 or later

Header

Dbghelp.h

Library

Dbghelp.lib

DLL

Dbghelp.dll

Unicode and ANSI names

EnumDirTreeW (Unicode) and EnumDirTree (ANSI)

See also

DbgHelp Functions
EnumDirTreeProc

 

 

Community Additions

ADD
Show:
© 2014 Microsoft