SymGetSourceFileFromTokenW function (dbghelp.h)

  • Article

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

Syntax

BOOL IMAGEAPI SymGetSourceFileFromTokenW(
  [in]           HANDLE hProcess,
  [in]           PVOID  Token,
  [in, optional] PCWSTR Params,
  [out]          PWSTR  FilePath,
  [in]           DWORD  Size
);

Parameters

[in] hProcess

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

[in] Token

A pointer to the token.

[in, optional] Params

This parameter is unused.

[out] FilePath

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

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

Note

The dbghelp.h header defines SymGetSourceFileFromToken as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

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

See also

DbgHelp Functions

Source Server