Partager via


IHelp.ShowHelp Method

Displays a Help topic.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function ShowHelp ( _
    szHelp As String, _
    fuCommand As UInteger, _
    dwHelpContext As UInteger _
) As Integer
int ShowHelp(
    string szHelp,
    uint fuCommand,
    uint dwHelpContext
)
int ShowHelp(
    [InAttribute] String^ szHelp, 
    [InAttribute] unsigned int fuCommand, 
    [InAttribute] unsigned int dwHelpContext
)
abstract ShowHelp : 
        szHelp:string * 
        fuCommand:uint32 * 
        dwHelpContext:uint32 -> int
function ShowHelp(
    szHelp : String, 
    fuCommand : uint, 
    dwHelpContext : uint
) : int

Parameters

  • szHelp
    Type: String

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

  • fuCommand
    Type: UInt32

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

  • dwHelpContext
    Type: 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.

Return Value

Type: 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
);

.NET Framework Security

See Also

Reference

IHelp Interface

Microsoft.VisualStudio.Shell.Interop Namespace