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)

Syntax

'Declaration
Function GetUserContext ( _
    index As UInteger, _
    <OutAttribute> ByRef ppunkUserCtx As Object _
) As Integer
int GetUserContext(
    uint index,
    out Object ppunkUserCtx
)
int GetUserContext(
    [InAttribute] unsigned int index, 
    [OutAttribute] Object^% ppunkUserCtx
)
abstract GetUserContext : 
        index:uint32 * 
        ppunkUserCtx:Object byref -> int
function GetUserContext(
    index : uint, 
    ppunkUserCtx : Object
) : int

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 vsshell80.idl:

[C++]

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

.NET Framework Security

See Also

Reference

IVsObjectList2 Interface

Microsoft.VisualStudio.Shell.Interop Namespace