IVsHelpSystem.GetCurrentURL Method

Retrieves the URL of the topic currently displayed in the topic window.

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

Syntax

'Declaration
Function GetCurrentURL ( _
    <OutAttribute> ByRef ppszURL As String _
) As Integer
'Usage
Dim instance As IVsHelpSystem
Dim ppszURL As String
Dim returnValue As Integer

returnValue = instance.GetCurrentURL(ppszURL)

int GetCurrentURL(
    out string ppszURL
)

int GetCurrentURL(
    [OutAttribute] String^% ppszURL
)

abstract GetCurrentURL : 
        ppszURL:string byref -> int 

function GetCurrentURL(
    ppszURL : String
) : int

Parameters

• ppszURL
  Type: System.String%
  [out] Pointer to a string containing the URL. The method allocates the string using SysAllocString. The caller is responsible for freeing the string with SysFreeString.

Return Value

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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IVsHelpSystem Interface

IVsHelpSystem Members

Microsoft.VisualStudio.Shell.Interop Namespace