ClipboardObject.IDataObject.GetCanonicalFormatEtc-Methode

Artikel
05/16/2015

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 ( _
    ByRef formatIn As FORMATETC, _
    <OutAttribute> ByRef formatOut As FORMATETC _
) As Integer Implements IDataObject.GetCanonicalFormatEtc

int IDataObject.GetCanonicalFormatEtc(
    ref FORMATETC formatIn,
    out FORMATETC formatOut
)

private:
virtual int GetCanonicalFormatEtc(
    FORMATETC% formatIn, 
    [OutAttribute] FORMATETC% formatOut
) sealed = IDataObject::GetCanonicalFormatEtc

private abstract GetCanonicalFormatEtc : 
        formatIn:FORMATETC byref * 
        formatOut:FORMATETC byref -> int  
private override GetCanonicalFormatEtc : 
        formatIn:FORMATETC byref * 
        formatOut:FORMATETC byref -> int

JScript unterstützt keine expliziten Schnittstellenimplementierungen

Parameter

formatIn
Typ: 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.

formatOut
Typ: FORMATETC%

Wenn diese Methode beendet wird, enthält dieser Parameter einen Zeiger an eine FORMATETC-Struktur, die die meisten Informationen, die für ein bestimmtes Rendering möglich sind und kanonisch erleichtert Entspricht pformatectIn. Der Aufrufer muss dieser Struktur zuweisen, und die GetCanonicalFormatEtc-Methode muss die Daten gefüllt. 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_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 formatOut-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 formatIn-Parameter ist ungültig.
OLE_E_NOTRUNNING	Die Anwendung wird nicht ausgeführt.

Implementiert

IDataObject.GetCanonicalFormatEtc(FORMATETC, FORMATETC)

Hinweise

Diese Methode delegiert den Aufruf an den entsprechenden GetCanonicalFormatEtc vom System.Runtime.InteropServices.ComTypes und Namespace angenommen, dass Zwischenablageobjekt vorhandenes IDataObject umschließt.

.NET Framework-Sicherheit

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.

Siehe auch

Referenz

ClipboardObject Klasse

Microsoft.VisualStudio.Data.Framework-Namespace

Freigeben über