Share via

IVsHelpSystem.GetCurrentURL(String) Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assembly:
Microsoft.VisualStudio.Shell.Interop.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.9.37000

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

public:
 int GetCurrentURL([Runtime::InteropServices::Out] System::String ^ % ppszURL);
int GetCurrentURL([Runtime::InteropServices::Out] std::wstring const & & ppszURL);
public int GetCurrentURL (out string ppszURL);
abstract member GetCurrentURL : string -> int
Public Function GetCurrentURL (ByRef ppszURL As String) As Integer

Parameters

ppszURL
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.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Applies to