This documentation is archived and is not being maintained.

IOleComponentUIManager.ShowHelp Method

Requests the display of Help information.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

int ShowHelp(
	uint dwCompRole,
	ref Guid rclsidComp,
	POINT posMouse,
	uint dwHelpCmd,
	string pszHelpFile,
	uint dwData


Type: System.UInt32

[in] Role of the VSPackage object requesting the Help display. For a list of valid dwCompRole values, see OLEROLE.

Type: System.Guid%

[in] Class identifier (CLSID) of the VSPackage object requesting the Help display.

Type: Microsoft.VisualStudio.OLE.Interop.POINT

[in] Identifies the position of the mouse.

Type: System.UInt32

[in] Identifies the Help command to be invoked.

Type: System.String

[in] Points to the path to the Help file to be displayed.

Type: System.UInt32

[in] Data specific to the VSPackage object.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

COM Signature

From oleipc.idl:

HRESULT IOleComponentUIManager::ShowHelp(
   [in] DWORD dwCompRole,
   [in] REFCLSID rclsidComp,
   [in] POINT posMouse,
   [in] DWORD dwHelpCmd,
   [in] LPOLESTR pszHelpFile,
   [in] DWORD dwData

ShowHelp calls the legacy SVsHelpService service. VSPackages can access a newer service for help by calling QueryService and requesting SID_SVsHelp and IID_Help. You are handed a pointer to the Help interface. Then call the method that displays help: DisplayTopicFromId.