IVsObjectList2.ShowHelp Method

Article
02/04/2013

Allows the list to display help for the given list item.

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

Syntax

'Declaration
Function ShowHelp ( _
    index As UInteger _
) As Integer

int ShowHelp(
    uint index
)

int ShowHelp(
    [InAttribute] unsigned int index
)

abstract ShowHelp : 
        index:uint32 -> int

function ShowHelp(
    index : uint
) : int

Parameters

index
Type: System.UInt32
[in] Specifies the index of the list item of interest.

Return Value

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

Remarks

COM Signature

From vsshell80.idl:

[C++]

HRESULT IVsObjectList2::ShowHelp(
   [in] ULONG Index
);

Most implementers should return E_NOTIMPL from this method and rely on the environment to provide help topics on the selected symbol. This method is provided, however, if the components your library is browsing have non-standard help, such as needing an external viewer.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via