IHelp.ShowHelp(String, UInt32, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Displays a Help topic.

public:
 int ShowHelp(System::String ^ szHelp, System::UInt32 fuCommand, System::UInt32 dwHelpContext);

public:
 int ShowHelp(Platform::String ^ szHelp, unsigned int fuCommand, unsigned int dwHelpContext);

int ShowHelp(std::wstring const & szHelp, unsigned int fuCommand, unsigned int dwHelpContext);

public int ShowHelp (string szHelp, uint fuCommand, uint dwHelpContext);

abstract member ShowHelp : string * uint32 * uint32 -> int

Public Function ShowHelp (szHelp As String, fuCommand As UInteger, dwHelpContext As UInteger) As Integer

Parameters

szHelp: String

[in] String containing the name and path of the Help file.

fuCommand: UInt32

[in] The context ID of the topic to display.

dwHelpContext: UInt32

[in] Bit flags indicating how to display the topic. For more information, see the Help constants, such as HELP_CONTEXTPOPUP, in the winuser.h file.

Returns

Int32

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

Remarks

COM Signature

From objtext.idl:

HRESULT IHelp::ShowHelp(  
   [in] LPOLESTR szHelp,   
   [in] UINT fuCommand,   
   [in] DWORD dwHelpContext  
);

Applies to