SymGetSourceFileFromToken Function

Retrieves the source file associated with the specified token from the source server.

BOOL WINAPI SymGetSourceFileFromToken(
  __in          HANDLE hProcess,
  __in          PVOID Token,
  __in_opt      PCTSTR Params,
  __out         PTSTR FilePath,
  __in          DWORD Size
);

Parameters

hProcess

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

Token

A pointer to the token.

Params

This parameter is unused.

FilePath

A pointer to a buffer that receives the fully-qualified path of the source file.

Size

The size of the FilePath buffer, in characters.

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

See Also

DbgHelp FunctionsSource Server

Send comments about this topic to Microsoft

Build date: 9/25/2007