IDebugSymbols3::GetSymbolPath method (dbgeng.h)

Article
02/22/2024

The GetSymbolPath method returns the symbol path.

Syntax

HRESULT GetSymbolPath(
  [out, optional] PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG PathSize
);

Parameters

[out, optional] 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.

[in] BufferSize

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

[out, optional] PathSize

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

Return value

These methods 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 symbol path and the path was truncated.

Remarks

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

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