Share via

IVsHelpSystem.DisplayTopicFromURL Method

  • Reference

Definition

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

Overloads

DisplayTopicFromURL(String, IntPtr)
DisplayTopicFromURL(String, UInt32)

Displays a topic using a URL and options.

DisplayTopicFromURL(String, IntPtr) 

public:
 int DisplayTopicFromURL(System::String ^ pszURL, IntPtr Command);
public int DisplayTopicFromURL (string pszURL, IntPtr Command);
abstract member DisplayTopicFromURL : string * nativeint -> int
Public Function DisplayTopicFromURL (pszURL As String, Command As IntPtr) As Integer

Parameters

pszURL
String
Command
IntPtr

nativeint

Returns

Int32

Applies to

DisplayTopicFromURL(String, UInt32)

Displays a topic using a URL and options.

public:
 int DisplayTopicFromURL(System::String ^ pszURL, System::UInt32 Command);
public:
 int DisplayTopicFromURL(Platform::String ^ pszURL, unsigned int Command);
int DisplayTopicFromURL(std::wstring const & pszURL, unsigned int Command);
public int DisplayTopicFromURL (string pszURL, uint Command);
abstract member DisplayTopicFromURL : string * uint32 -> int
Public Function DisplayTopicFromURL (pszURL As String, Command As UInteger) As Integer

Parameters

pszURL
String

[in] Pointer to a string containing the URL.

Command
UInt32

[in] Bit flags specifying Help options. Constructed from values in the VHS_COMMAND enumeration and the HTML Help commands

Returns

Int32

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

Remarks

In order to use VHS_Localize with this method, you need to specify the URL in one of the following forms:

[C++]

filename.chm  
filename.chm::/path\name.htm

For example, the following two URLs are valid:

[C++]

Vj98help.chm  
Vj98help.chm::/html\vjmsgcompilererror.htm

Applies to