Edit

Share via

IDebugSymbols3::GetSourcePathWide method (dbgeng.h)

  • Article

The GetSourcePathWide method returns the source path.

Syntax

HRESULT GetSourcePathWide(
  [out, optional] PWSTR  Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG PathSize
);

Parameters

[out, optional] Buffer

Receives the source path. This is a string that contains source path elements separated by semicolons (;). Each source path element can specify either a directory or a source server. If Buffer is NULL, this information is not returned.

[in] BufferSize

Specifies the size, in characters, of the Buffer buffer.

[out, optional] PathSize

Receives the size, in characters, of the source path.

Return value

This method can also return error values. See Return Values for more details.

Return code Description
S_OK
 The method was successful.
S_FALSE
 The method was successful. However, the buffer was not large enough to hold the source path and the path was truncated.

Remarks

The source path is used by the engine when searching for source files.

For more information about manipulating the source path, see Using Source Files. For an overview of the source path and its syntax, see Source Path.

Requirements

Requirement Value
Target Platform Desktop
Header dbgeng.h (include Dbgeng.h)

See also

AppendSourcePath

GetSourcePathElement

IDebugSymbols3

SetSourcePath