Edit

Share via

SymSrvGetFileIndexString function (dbghelp.h)

  • Article

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

Syntax

BOOL IMAGEAPI SymSrvGetFileIndexString(
  [in]           HANDLE hProcess,
  [in, optional] PCSTR  SrvPath,
  [in]           PCSTR  File,
  [out]          PSTR   Index,
  [in]           size_t Size,
  [in]           DWORD  Flags
);

Parameters

[in] hProcess

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

[in, optional] SrvPath

The path to the symbol server.

[in] File

The name of the file.

[out] Index

A pointer to a buffer that receives the index string.

[in] Size

The size of the Index buffer, in characters.

[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.

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

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

See also

DbgHelp Functions