IOleComponentUIManager::ShowHelp Method (UInt32, Guid, POINT, UInt32, String^, UInt32)
Visual Studio 2015
Requests the display of Help information.
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
int ShowHelp( unsigned int dwCompRole, [InAttribute] Guid% rclsidComp, POINT posMouse, unsigned int dwHelpCmd, String^ pszHelpFile, unsigned int dwData )
Parameters
- dwCompRole
-
Type:
System::UInt32
[in] Role of the VSPackage object requesting the Help display. For a list of valid dwCompRole values, see OLEROLE.
- rclsidComp
-
Type:
System::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:
System::UInt32
[in] Identifies the Help command to be invoked.
- pszHelpFile
-
Type:
System::String^
[in] Points to the path to the Help file to be displayed.
- dwData
-
Type:
System::UInt32
[in] Data specific to the VSPackage object.
Return Value
Type: System::Int32If the method succeeds, it returns S_OK. If it fails, it returns an error code.
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: