IVsProvideUserContext.GetUserContext(IVsUserContext) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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.

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

public:
 int GetUserContext([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsUserContext ^ % ppctx);

public:
 int GetUserContext([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsUserContext ^ &  ppctx);

int GetUserContext([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsUserContext const & & ppctx);

public int GetUserContext (out Microsoft.VisualStudio.Shell.Interop.IVsUserContext ppctx);

abstract member GetUserContext : IVsUserContext -> int

Public Function GetUserContext (ByRef ppctx As IVsUserContext) As Integer

Parameters

ppctx: IVsUserContext

[out] Pointer to the IVsUserContext interface, representing the context bag for the selection container.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

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.

Applies to

Share via