IVsObjectList::ShowHelp Method (UInt32)

Visual Studio 2015

Visual Studio 2013
Visual Studio 2012
Visual Studio 2010
Visual Studio 2008
Visual Studio 2005

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

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

Syntax

C++

int ShowHelp(
	unsigned int index
)

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 vsshell.idl:

C++

HRESULT IVsObjectList::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 an external viewer).