IVsToolboxClipboardCycler.GetAndSelectNextDataObject Method

Article
04/29/2015

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

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

Syntax

'Declaration
Function GetAndSelectNextDataObject ( _
    pTarget As IVsToolboxUser, _
    <OutAttribute> ByRef ppDO As IDataObject _
) As Integer

int GetAndSelectNextDataObject(
    IVsToolboxUser pTarget,
    out IDataObject ppDO
)

int GetAndSelectNextDataObject(
    [InAttribute] IVsToolboxUser^ pTarget, 
    [OutAttribute] IDataObject^% ppDO
)

abstract GetAndSelectNextDataObject : 
        pTarget:IVsToolboxUser * 
        ppDO:IDataObject byref -> int

function GetAndSelectNextDataObject(
    pTarget : IVsToolboxUser, 
    ppDO : IDataObject
) : int

Parameters

pTarget
Type: Microsoft.VisualStudio.Shell.Interop.IVsToolboxUser

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

ppDO
Type: Microsoft.VisualStudio.OLE.Interop.IDataObject%

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

Return Value

Type: 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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via