Freigeben über


ClipboardObject.IDataObject.GetCanonicalFormatEtc-Methode

Stellt eine Standard-FORMATETC-Struktur bereit, die einer komplexeren Struktur logisch entspricht. Verwenden Sie diese Methode, um zu ermitteln, ob zwei unterschiedliche FORMATETC-Strukturen dieselben Daten zurückgeben und die Notwendigkeit doppeltes Rendering entfernen.

Namespace:  Microsoft.VisualStudio.Data.Framework
Assembly:  Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)

Syntax

'Declaration
Private Function GetCanonicalFormatEtc ( _
    pformatectIn As FORMATETC(), _
    pformatetcOut As FORMATETC() _
) As Integer Implements IDataObject.GetCanonicalFormatEtc
int IDataObject.GetCanonicalFormatEtc(
    FORMATETC[] pformatectIn,
    FORMATETC[] pformatetcOut
)
private:
virtual int GetCanonicalFormatEtc(
    array<FORMATETC>^ pformatectIn, 
    array<FORMATETC>^ pformatetcOut
) sealed = IDataObject::GetCanonicalFormatEtc
private abstract GetCanonicalFormatEtc : 
        pformatectIn:FORMATETC[] * 
        pformatetcOut:FORMATETC[] -> int  
private override GetCanonicalFormatEtc : 
        pformatectIn:FORMATETC[] * 
        pformatetcOut:FORMATETC[] -> int
JScript unterstützt keine expliziten Schnittstellenimplementierungen

Parameter

  • pformatectIn
    Typ: array<FORMATETC[]

    Ein Verweis auf eine FORMATETC übergeben, Struktur durch einen Verweis, der das Format, den mittleren und das Zielgerät definiert, die der Aufrufer verwenden möchte, um Daten in einem abschließenden Aufruf abzurufen, wie IDataObject.GetData. Der tymed-Member hat in diesem Fall keine Bedeutung und sollte ignoriert werden.

  • pformatetcOut
    Typ: array<FORMATETC[]

    Enthält nach dem Beenden dieser Methode einen Zeiger auf eine FORMATETC-Struktur, die sehr allgemeine Informationen für ein bestimmtes Rendering enthält, wodurch sie kanonisch äquivalent zu pformatectIn ist. Der Aufrufer muss diese Struktur zuordnen, und die GetCanonicalFormatEtc-Methode muss die Daten ausfüllen. Um Daten in einem abschließenden Aufruf, wie beispielsweise IDataObject.GetData abrufen, die Aufruferverwendung der angegebene Wert pformatetcOut, es sei denn, der angegebene Wert nullein Nullverweis (Nothing in Visual Basic) ist. Dieser Wert ist NULL, wenn die Methode DATA_S_SAMEFORMATETC zurückgibt. Der tymed-Member hat in diesem Fall keine Bedeutung und sollte ignoriert werden. Dieser Parameter wird nicht initialisiert übergeben.

Rückgabewert

Typ: Int32
Diese Methode unterstützt die Standardrückgabewerte E_INVALIDARG, E_FAIL, E_UNEXPECTED und E_OUTOFMEMORY sowie Folgendes:

Wert

Beschreibung

S_OK

Die zurückgegebene FORMATETC-Struktur ist von der Zeichenfolge unterscheiden, die übergeben wurde.

DATA_S_SAMEFORMATETC

Die FORMATETC-Strukturen sind identisch und ein NULL-Verweis wird im pformatetcOut-Parameter zurückgegeben.

DV_E_LINDEX

Ein Wert für lindex ist ungültig. Derzeit wird nur -1 unterstützt.

DV_E_FORMATETC

Ein Wert für den pformatectIn-Parameter ist ungültig.

OLE_E_NOTRUNNING

Die Anwendung wird nicht ausgeführt.

Implementiert

IDataObject.GetCanonicalFormatEtc(FORMATETC, FORMATETC)

Hinweise

Wenn das Zwischenablageobjekt vorhandenes IDataObject ( Microsoft.VisualStudio.OLE.Interop ) vom Namespace umschließt, Delegaten Methode den Aufruf an den entsprechenden GetCanonicalFormatEtc dieser Namespace. Andernfalls versucht es, den Aufruf von GetCanonicalFormatEtc vom System.Runtime.InteropServices.ComTypes-Namespace zu übersetzen, falls das Zwischenablageobjekt vorhandenes IDataObject umschließen konnte.

.NET Framework-Sicherheit

Siehe auch

Referenz

ClipboardObject Klasse

Microsoft.VisualStudio.Data.Framework-Namespace