SymSrvGetFileIndexString Function

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

BOOL WINAPI SymSrvGetFileIndexString(
  __in          HANDLE hProcess,
  __in          PCTSTR SrvPath,
  __in          PCTSTR File,
  __out         PTSTR Index,
  __in          size_t Size,
                DWORD Flags
);

Parameters

hProcess

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

SrvPath

The path to the symbol server.

File

The name of the file.

Index

A pointer to a buffer that receives the index string.

Size

The size of the Index buffer, in characters.

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

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	Requires DbgHelp.dll 6.3 or later.
Header	Declared in DbgHelp.h.
Library	Use Dbghelp.lib.
DLL	Requires Dbghelp.dll.
Unicode	Implemented as SymSrvGetFileIndexStringW (Unicode) and SymSrvGetFileIndexString (ANSI).

See Also

DbgHelp Functions

Send comments about this topic to Microsoft

Build date: 9/25/2007