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)

'Declaration
Function ShowHelp ( _
	<InAttribute> dwCompRole As UInteger, _
	<InAttribute> ByRef rclsidComp As Guid, _
	<InAttribute> posMouse As POINT, _
	<InAttribute> dwHelpCmd As UInteger, _
	<InAttribute> pszHelpFile As String, _
	<InAttribute> dwData As UInteger _
) As Integer
'Usage
Dim instance As IOleComponentUIManager
Dim dwCompRole As UInteger
Dim rclsidComp As Guid
Dim posMouse As POINT
Dim dwHelpCmd As UInteger
Dim pszHelpFile As String
Dim dwData As UInteger
Dim returnValue As Integer

returnValue = instance.ShowHelp(dwCompRole, rclsidComp, posMouse, dwHelpCmd, pszHelpFile, 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.

Parameters

dwCompRole

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

rclsidComp

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

posMouse

[in] Identifies the position of the mouse.

dwHelpCmd

[in] Identifies the Help command to be invoked.

pszHelpFile

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

dwData

[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.

Community Additions

ADD
Show:
© 2015 Microsoft