SymGetSourceFileToken function (dbghelp.h)

Article
02/22/2024

Retrieves token for the specified source file from the source server.

Syntax

BOOL IMAGEAPI SymGetSourceFileToken(
  [in]  HANDLE  hProcess,
  [in]  ULONG64 Base,
  [in]  PCSTR   FileSpec,
  [out] PVOID   *Token,
  [out] DWORD   *Size
);

Parameters

[in] hProcess

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

[in] Base

The base address of the module.

[in] FileSpec

The name of the source file.

[out] Token

A pointer to a buffer that receives the token.

[out] Size

The size of the Token buffer, in bytes.

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

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