IVsObjectList2::GetClipboardFormat Method (UInt32, UInt32, array<FORMATETC>^, array<STGMEDIUM>^)

Visual Studio 2015

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

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

Syntax

C++

int GetClipboardFormat(
	unsigned int index,
	unsigned int grfFlags,
	array<FORMATETC>^ pFormatetc,
	array<STGMEDIUM>^ pMedium
)

Parameters

index: Type: System::UInt32
[in] Specifies the index of the list item of interest.

grfFlags: Type: System::UInt32
[in] Specifies multi-selection. Values are taken from the _VSOBJCFFLAGS enumeration.

pFormatetc: Type: array<Microsoft.VisualStudio.OLE.Interop::FORMATETC>^
[in] Pointer to a FORMATETC structure containing clipboard format information.

pMedium: Type: array<Microsoft.VisualStudio.OLE.Interop::STGMEDIUM>^
[in] Pointer to a STGMEDIUM structure indicating the data transfer medium.

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 vsshell80.idl:

[C++]

HRESULT IVsObjectList2::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 calls 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.