IVsHelpSystem.DisplayTopicFromIdentifier Method

Displays a topic based on an identifier.

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

Syntax

'Declaration
Function DisplayTopicFromIdentifier ( _
    pszFile As String, _
    Id As UInteger, _
    Command As UInteger _
) As Integer
int DisplayTopicFromIdentifier(
    string pszFile,
    uint Id,
    uint Command
)
int DisplayTopicFromIdentifier(
    [InAttribute] String^ pszFile, 
    [InAttribute] unsigned int Id, 
    [InAttribute] unsigned int Command
)
abstract DisplayTopicFromIdentifier : 
        pszFile:string * 
        Id:uint32 * 
        Command:uint32 -> int
function DisplayTopicFromIdentifier(
    pszFile : String, 
    Id : uint, 
    Command : uint
) : int

Parameters

  • pszFile
    Type: String

    [in] Pointer to a string containing the file name of the Help file.

  • Id
    Type: UInt32

    [in] The Help topic identifier.

  • Command
    Type: UInt32

    [in] Bit flags specifying Help options. Constructed from values in the VHS_COMMAND enumeration and the HTML Help commands.

Return Value

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

.NET Framework Security

See Also

Reference

IVsHelpSystem Interface

Microsoft.VisualStudio.Shell.Interop Namespace