Share via


IVsObjectList.GetClipboardFormat Method

Asks the given list item to renders a specific clipboard format that it supports.

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

Syntax

'Declaration
Function GetClipboardFormat ( _
    index As UInteger, _
    grfFlags As UInteger, _
    pFormatetc As FORMATETC(), _
    pMedium As STGMEDIUM() _
) As Integer
int GetClipboardFormat(
    uint index,
    uint grfFlags,
    FORMATETC[] pFormatetc,
    STGMEDIUM[] pMedium
)
int GetClipboardFormat(
    [InAttribute] unsigned int index, 
    [InAttribute] unsigned int grfFlags, 
    [InAttribute] array<FORMATETC>^ pFormatetc, 
    [InAttribute] array<STGMEDIUM>^ pMedium
)
abstract GetClipboardFormat : 
        index:uint32 * 
        grfFlags:uint32 * 
        pFormatetc:FORMATETC[] * 
        pMedium:STGMEDIUM[] -> int
function GetClipboardFormat(
    index : uint, 
    grfFlags : uint, 
    pFormatetc : FORMATETC[], 
    pMedium : STGMEDIUM[]
) : int

Parameters

  • index
    Type: System.UInt32

    [in] Specifies the index of the list item of interest.

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:

HRESULT IVsObjectList::GetClipboardFormat(
   [in] ULONG Index,
   [in] VSOBJCFFLAGS grfFlags,
   [in] FORMATETC *pFormatetc,
   [in] STGMEDIUM *pMedium
);

When the user requests a copy-paste or drag-drop operation on an item in your object list, the environment will call EnumClipboardFormats to see which formats your list supports. The environment then calls GetClipboardFormat for the item when the actual paste or drop operation happens. You then render the item in the requested format.

.NET Framework Security

See Also

Reference

IVsObjectList Interface

Microsoft.VisualStudio.Shell.Interop Namespace