GetSymbolPath

The GetSymbolPath and GetSymbolPathWide methods return the symbol path.

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

IDebugSymbols3::GetSymbolPathWide(
    OUT OPTIONAL PSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  PathSize
    );

#ifdef UNICODE
#define GetSymbolPathT GetSymbolPathWide
#else
#define GetSymbolPathT GetSymbolPath
#endif

Parameters

Buffer

Receives the symbol path. This is a string that contains symbol path elements separated by semicolons (;). Each symbol path element can specify either a directory or a symbol 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 symbol 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 symbol path and the path was truncated.

These methods can also return error values. See Return Values for more details.

Interface Version

GetSymbolPath is available in all versions of IDebugSymbols. GetSymbolPathWide is available in IDebugSymbols3 and later versions.

Comments

For more information about manipulating the symbol path, see Using Symbols. For an overview of the symbol path and its syntax, see Symbol Path.

Requirements

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

See Also

SetSymbolPath, AppendSymbolPath