SymGetSourceFile Function

Retrieves the specified source file from the source server.

BOOL WINAPI SymGetSourceFile(
  __in          HANDLE hProcess,
  __in          ULONG64 Base,
  __in_opt      PCSTR Params,
  __in          PCSTR FileSpec,
  __out         PSTR FilePath,
  __in          DWORD Size
);

Parameters

hProcess

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

Base

The base address of the module.

Params

This parameter is unused.

FileSpec

The name of the source file.

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

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.

Requirements

See Also

DbgHelp FunctionsSource Server

Send comments about this topic to Microsoft

Build date: 9/25/2007