IVsToolboxClipboardCycler.GetAndSelectNextDataObject 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.

Gets the next data object for the target Toolbox user's clipboard ring.

public:
 int GetAndSelectNextDataObject(Microsoft::VisualStudio::Shell::Interop::IVsToolboxUser ^ pTarget, [Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IDataObject ^ % ppDO);

public:
 int GetAndSelectNextDataObject(Microsoft::VisualStudio::Shell::Interop::IVsToolboxUser ^ pTarget, [Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IDataObject ^ &  ppDO);

int GetAndSelectNextDataObject(Microsoft::VisualStudio::Shell::Interop::IVsToolboxUser const & pTarget, [Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IDataObject const & & ppDO);

public int GetAndSelectNextDataObject (Microsoft.VisualStudio.Shell.Interop.IVsToolboxUser pTarget, out Microsoft.VisualStudio.OLE.Interop.IDataObject ppDO);

abstract member GetAndSelectNextDataObject : Microsoft.VisualStudio.Shell.Interop.IVsToolboxUser * IDataObject -> int

Public Function GetAndSelectNextDataObject (pTarget As IVsToolboxUser, ByRef ppDO As IDataObject) As Integer

Parameters

pTarget: IVsToolboxUser

[in] Target Toolbox user to cycle through clipboard items.

ppDO: IDataObject

[out] Pointer to the next data object in the list.

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 IVsToolboxClipboardCycler::GetAndSelectNextDataObject(  
   [in] IVsToolboxUser *pTarget,  
   [out] IDataObject **ppDO  
);

This method requires you to specify an IVsToolboxUser and does not assume that the IVsToolboxUser for the active document is the target toolbox user. Because IVsToolboxUser is reserved for documents, you need to implement IVsToolboxUser if you want to provide clipboard cycling for a tool window. Once you do this, you can implement clipboard cycling by passing in your tool window's IVsToolboxUser in a call to IVsToolboxClipboardCycler::GetAndSelectNextDataObject.

Applies to