SymGetSourceFile function (dbghelp.h)

Article
08/09/2022

Retrieves the specified source file from the source server.

Syntax

BOOL IMAGEAPI SymGetSourceFile(
  [in]           HANDLE  hProcess,
  [in]           ULONG64 Base,
  [in, optional] PCSTR   Params,
  [in]           PCSTR   FileSpec,
  [out]          PSTR    FilePath,
  [in]           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, optional] Params

This parameter is unused.

[in] FileSpec

The name of the source file.

[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

To control which directory receives the source files, use the SymSetHomeDirectory function.

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