Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
ShowHelp Method

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
)

Parameters

dwCompRole
Type: UInt32

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

rclsidComp
Type: Guid

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

posMouse
Type: Microsoft.VisualStudio.OLE.Interop.POINT

[in] Identifies the position of the mouse.

dwHelpCmd
Type: UInt32

[in] Identifies the Help command to be invoked.

pszHelpFile
Type: String

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

dwData
Type: UInt32

[in] Data specific to the VSPackage object.

Return Value

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

Show:
© 2015 Microsoft