This documentation is archived and is not being maintained.

IVsObjectList2.GetUserContext Method

Returns the user context object 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 GetUserContext(
	uint index,
	out Object ppunkUserCtx


Type: System.UInt32

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

Type: System.Object%

[out] Pointer to a context bag returned as an IUnknown interface.

Return Value

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

COM Signature

From vsshell80.idl:

HRESULT IVsObjectList2::GetUserContext(
   [in] ULONG Index, 
   [out] IUnknown **ppunkUserCtx

By default, the environment uses the fully qualified item name as the F1 keyword for dynamic help. Use the GetUserContext method to supply supplemental dynamic help information, such as Language ID, for the given list item when it is selected. The returned context bag must support IVsUserContext to provide additional context attributes and keywords.