IVsHelpSystem Interface

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assembly:
Microsoft.VisualStudio.Shell.Interop.dll
Assembly:
Microsoft.VisualStudio.Interop.dll

Provides access to the help system.

public interface class IVsHelpSystem
public interface class IVsHelpSystem
__interface IVsHelpSystem
[System.Runtime.InteropServices.Guid("854D7AC0-BC3D-11D0-B421-00A0C90F9DC4")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsHelpSystem
[System.Runtime.InteropServices.Guid("854D7AC0-BC3D-11D0-B421-00A0C90F9DC4")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsHelpSystem
[<System.Runtime.InteropServices.Guid("854D7AC0-BC3D-11D0-B421-00A0C90F9DC4")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsHelpSystem = interface
[<System.Runtime.InteropServices.Guid("854D7AC0-BC3D-11D0-B421-00A0C90F9DC4")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsHelpSystem = interface
Public Interface IVsHelpSystem
Attributes
GuidAttribute InterfaceTypeAttribute

Methods

ActivateHelpSystem(IntPtr)
ActivateHelpSystem(UInt32)

Starts the Help system and displays the table of contents.
ALinkSearch(String, IntPtr, IntPtr)
ALinkSearch(String, UInt32, UInt32)

Performs an Alink search based on the word, flags, and context.
DisplayTopicFromIdentifier(String, IntPtr, IntPtr)
DisplayTopicFromIdentifier(String, UInt32, UInt32)

Displays a topic based on an identifier.
DisplayTopicFromURL(String, IntPtr)
DisplayTopicFromURL(String, UInt32)

Displays a topic using a URL and options.
FullTextSearchDlg(String, IntPtr, IntPtr)
FullTextSearchDlg(String, UInt32, UInt32)

Displays the full text search dialog.
GetCurrentURL(String)

Retrieves the URL of the topic currently displayed in the topic window.
KeywordSearch(String, IntPtr, IntPtr)
KeywordSearch(String, UInt32, UInt32)

Performs an F1 search based on a keyword, flags, and context.
KeywordSearchDlg(String, IntPtr, IntPtr)
KeywordSearchDlg(String, UInt32, UInt32)

Displays the keyword search dialog pre-populated with the keyword.
Reserved(VHS_COMMAND, VsHelpErrors)

Applies to