IVsSimpleObjectList2.GetUserContext(UInt32, Object) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the user context object for the given list item.

public:
 int GetUserContext(System::UInt32 index, [Runtime::InteropServices::Out] System::Object ^ % ppunkUserCtx);

int GetUserContext(unsigned int index, [Runtime::InteropServices::Out] winrt::Windows::Foundation::IInspectable const & & ppunkUserCtx);

public int GetUserContext (uint index, out object ppunkUserCtx);

abstract member GetUserContext : uint32 * obj -> int

Public Function GetUserContext (index As UInteger, ByRef ppunkUserCtx As Object) As Integer

Parameters

index: UInt32

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

ppunkUserCtx: Object

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

Returns

Int32

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

Remarks

COM Signature

From vsshell80.idl:

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

Applies to

Share via