IVsProvideUserContext::GetUserContext Method (IVsUserContext^)

Visual Studio 2015

Informs the environment where the selection's context is located.

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

Syntax

C++

int GetUserContext(
	[OutAttribute] IVsUserContext^% ppctx
)

Parameters

ppctx: Type: Microsoft.VisualStudio.Shell.Interop::IVsUserContext^
[out] Pointer to the IVsUserContext interface, representing the context bag for the selection container.

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 IVsProvideUserContext::GetUserContext(
   [out, retval] IVsUserContext ** ppctx
);

If this method is called, create a context bag, fill it with the appropriate attributes and keywords, and set the ppctx pointer to inform the environment of where the context is. The context bag is then associated with an ISelectionContainer object. For information about how to create a context bag, see IVsMonitorUserContext. For information about how to manage a context bag, see IVsUserContext.