This documentation is archived and is not being maintained.

IVsObjectList2.ShowHelp Method

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)

int ShowHelp (
	[InAttribute] uint index
)
int ShowHelp (
	/** @attribute InAttribute() */ UInt32 index
)
function ShowHelp (
	index : uint
) : int

Parameters

index

[in] Specifies the index of the list item of interest.

Return Value

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

COM Signature

From vsshell80.idl:

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

Most implementers should return E_NOTIMPL from this method and rely on the environment's dynamic help mechanism 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.

Show: