IOleComponentUIManager.ShowHelp Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Requests the display of Help information.

public:
 int ShowHelp(System::UInt32 dwCompRole, Guid % rclsidComp, Microsoft::VisualStudio::OLE::Interop::POINT posMouse, System::UInt32 dwHelpCmd, System::String ^ pszHelpFile, System::UInt32 dwData);

public int ShowHelp (uint dwCompRole, ref Guid rclsidComp, Microsoft.VisualStudio.OLE.Interop.POINT posMouse, uint dwHelpCmd, string pszHelpFile, uint dwData);

abstract member ShowHelp : uint32 * Guid * Microsoft.VisualStudio.OLE.Interop.POINT * uint32 * string * uint32 -> int

Public Function ShowHelp (dwCompRole As UInteger, ByRef rclsidComp As Guid, posMouse As POINT, dwHelpCmd As UInteger, pszHelpFile As String, dwData As UInteger) As Integer

Parameters

dwCompRole

UInt32

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

rclsidComp

Guid

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

posMouse

POINT

[in] Identifies the position of the mouse.

dwHelpCmd

UInt32

[in] Identifies the Help command to be invoked.

pszHelpFile

String

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

dwData

UInt32

[in] Data specific to the VSPackage object.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

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.