SymSrvGetFileIndexInfoW function (dbghelp.h)

Article
02/22/2024

Retrieves the index information for the specified .pdb, .dbg, or image file.

Syntax

BOOL IMAGEAPI SymSrvGetFileIndexInfoW(
  [in]  PCWSTR              File,
  [out] PSYMSRV_INDEX_INFOW Info,
  [in]  DWORD               Flags
);

Parameters

[in] File

The name of the file.

[out] Info

A SYMSRV_INDEX_INFO structure that receives the index information.

[in] Flags

This parameter is reserved for future use.

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

This function is not for general use. Those writing utilities for the management of files in symbol server stores may use to this function to predict the relative path the symbol server will look for a file. It is used by srctool.exe to actually populate symbol server stores. It may also be of use to those looking to find the parameters to feed the SymFindFileInPath function.

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.

Note

The dbghelp.h header defines SymSrvGetFileIndexInfo as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Target Platform	Windows
Header	dbghelp.h
Library	Dbghelp.lib
DLL	Dbghelp.dll
Redistributable	DbgHelp.dll 6.6 or later