Export (0) Print
Expand All

IVsHelpSystem.DisplayTopicFromURL Method

Displays a topic using a URL and options.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in microsoft.visualstudio.shell.interop.dll)

int DisplayTopicFromURL (
	[InAttribute] string pszURL,
	[InAttribute] uint Command
)
int DisplayTopicFromURL (
	/** @attribute InAttribute() */ String pszURL, 
	/** @attribute InAttribute() */ UInt32 Command
)
function DisplayTopicFromURL (
	pszURL : String, 
	Command : uint
) : int

Parameters

pszURL

[in] Pointer to a string containing the URL.

Command

[in] Bit flags specifying Help options. Constructed from values in the VHS_COMMAND enumeration and the HTML Help commands. For more informations, see About Commands.

Return Value

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

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

Community Additions

ADD
Show:
© 2014 Microsoft