GetSourcePath

The GetSourcePath and GetSourcePathWide methods return the source path.

IDebugSymbols::GetSourcePath(
    OUT OPTIONAL PSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  PathSize
    );

IDebugSymbols3::GetSourcePathWide(
    OUT OPTIONAL PCWSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  PathSize
    );

#ifdef UNICODE
#define GetSourcePathT GetSourcePathWide
#else
#define GetSourcePathT GetSourcePath
#endif

Parameters

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.

BufferSize

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

PathSize

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

Return Value

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.

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

Interface Version

GetSourcePath is available in all versions of IDebugSymbols. GetSourcePathWide is available in IDebugSymbols3 and later versions.

Comments

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

Headers: Defined in Dbgeng.h. Include Dbgeng.h.

See Also

AppendSourcePath, SetSourcePath, GetSourcePathElement