SymGetSourceFileFromToken function

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

Syntax


BOOL WINAPI SymGetSourceFileFromToken(
  _In_     HANDLE hProcess,
  _In_     PVOID  Token,
  _In_opt_ PCTSTR Params,
  _Out_    PTSTR  FilePath,
  _In_     DWORD  Size
);

Parameters

hProcess [in]

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

Token [in]

A pointer to the token.

Params [in, optional]

This parameter is unused.

FilePath [out]

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

Size [in]

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

DbgHelp.dll 6.2 or later

Header

Dbghelp.h

Library

Dbghelp.lib

DLL

Dbghelp.dll

Unicode and ANSI names

SymGetSourceFileFromTokenW (Unicode) and SymGetSourceFileFromToken (ANSI)

See also

DbgHelp Functions
Source Server

 

 

Show: