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

int ShowHelp (
	[InAttribute] unsigned int dwCompRole, 
	[InAttribute] Guid% rclsidComp, 
	[InAttribute] POINT posMouse, 
	[InAttribute] unsigned int dwHelpCmd, 
	[InAttribute] String^ pszHelpFile, 
	[InAttribute] unsigned int dwData
int ShowHelp (
	/** @attribute InAttribute() */ UInt32 dwCompRole, 
	/** @attribute InAttribute() */ /** @ref */ Guid rclsidComp, 
	/** @attribute InAttribute() */ POINT posMouse, 
	/** @attribute InAttribute() */ UInt32 dwHelpCmd, 
	/** @attribute InAttribute() */ String pszHelpFile, 
	/** @attribute InAttribute() */ UInt32 dwData
JScript does not support passing value-type arguments by reference.



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


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


[in] Identifies the position of the mouse.


[in] Identifies the Help command to be invoked.


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


[in] Data specific to the VSPackage object.

Return Value

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.