IVsDebugger2.GetSymbolPath Method

  • Article

Gets the current symbol path and cache settings.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Declaration
Function GetSymbolPath ( _
    <OutAttribute> ByRef pbstrSymbolPath As String, _
    <OutAttribute> ByRef pbstrSymbolCachePath As String _
) As Integer

int GetSymbolPath(
    out string pbstrSymbolPath,
    out string pbstrSymbolCachePath
)

int GetSymbolPath(
    [OutAttribute] String^% pbstrSymbolPath, 
    [OutAttribute] String^% pbstrSymbolCachePath
)

abstract GetSymbolPath : 
        pbstrSymbolPath:string byref * 
        pbstrSymbolCachePath:string byref -> int 

function GetSymbolPath(
    pbstrSymbolPath : String, 
    pbstrSymbolCachePath : String
) : int

Parameters

  • pbstrSymbolPath
    Type: System.String%
    [out] The current symbol path.
  • pbstrSymbolCachePath
    Type: System.String%
    [out] The current symbol cache path.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The symbol path, pbstrSymbolPath or pbstrSymbolCachePath, is a list of symbol-server locations, separated by semicolons. Optionally, it can begin with one or more cache locations followed by a semicolon.

The symbol path can also contain one or more cache locations. Caches are listed in priority order, with the highest priority cache first, and separated by * symbols. For example:

\\symbols\symbols;\\someotherserver\symbols;c:\symbols\httpsymbols*http://msdl.microsoft.com

COM Signature

From vsshell80.idl:

HRESULT GetSymbolPath(
    [out] BSTR *pbstrSymbolPath,
    [out] BSTR *pbstrSymbolCachePath
);

.NET Framework Security

See Also

Reference

IVsDebugger2 Interface

Microsoft.VisualStudio.Shell.Interop Namespace