SymSrvGetFileIndexString function
Retrieves the index string for the specified .pdb, .dbg, or image file.
Syntax
BOOL WINAPI SymSrvGetFileIndexString( _In_ HANDLE hProcess, _In_opt_ PCTSTR SrvPath, _In_ PCTSTR File, _Out_ PTSTR Index, _In_ size_t Size, _In_ DWORD Flags );
Parameters
- hProcess [in]
-
A handle to a process. This handle must have been previously passed to the SymInitialize function.
- SrvPath [in, optional]
-
The path to the symbol server.
- File [in]
-
The name of the file.
- Index [out]
-
A pointer to a buffer that receives the index string.
- Size [in]
-
The size of the Index buffer, in characters.
- Flags [in]
-
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
|
Redistributable |
DbgHelp.dll 6.3 or later |
|---|---|
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names |
SymSrvGetFileIndexStringW (Unicode) and SymSrvGetFileIndexString (ANSI) |
See also