IVsObjectList::GetUserContext Method (UInt32, Object^)

Visual Studio 2015

Returns the user context object for the given list item.

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

Syntax

C++

int GetUserContext(
	unsigned int index,
	[OutAttribute] Object^% ppunkUserCtx
)

Parameters

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

ppunkUserCtx: 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.

Remarks

COM Signature

From vsshell.idl:

C++

HRESULT IVsObjectList::GetUserContext(
   [in] ULONG Index,
   [out] IUnknown **ppunkUserCtx
);

By default, the environment uses the fully qualified item name as the F1 keyword. Use the GetUserContext method to supply supplemental 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.