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)

Syntax

'Declaration
Function DisplayTopicFromURL ( _
    pszURL As String, _
    Command As UInteger _
) As Integer
'Usage
Dim instance As IVsHelpSystem
Dim pszURL As String
Dim Command As UInteger
Dim returnValue As Integer

returnValue = instance.DisplayTopicFromURL(pszURL, _
    Command)

int DisplayTopicFromURL(
    string pszURL,
    uint Command
)

int DisplayTopicFromURL(
    [InAttribute] String^ pszURL, 
    [InAttribute] unsigned int Command
)

abstract DisplayTopicFromURL : 
        pszURL:string * 
        Command:uint32 -> int 

function DisplayTopicFromURL(
    pszURL : String, 
    Command : uint
) : int

Parameters

• pszURL
  Type: System.String
  [in] Pointer to a string containing the URL.

• Command
  Type: System.UInt32
  [in] Bit flags specifying Help options. Constructed from values in the VHS_COMMAND enumeration and the HTML Help commands

Return Value

Type: System.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

.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