Share via


IVsSimpleObjectList2.ShowHelp(UInt32) Method

Definition

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

public:
 int ShowHelp(System::UInt32 index);
public:
 int ShowHelp(unsigned int index);
int ShowHelp(unsigned int index);
public int ShowHelp (uint index);
abstract member ShowHelp : uint32 -> int
Public Function ShowHelp (index As UInteger) As Integer

Parameters

index
UInt32

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

Returns

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

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsSimpleObjectList2::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.

Applies to