IDataObject.GetCanonicalFormatEtc(FORMATETC, FORMATETC) Méthode

Définition

Espace de noms:
System.Runtime.InteropServices.ComTypes
Assembly:
System.dll
Assembly:
netstandard.dll

Fournit une structure standard FORMATETC qui équivaut logiquement à une structure plus complexe. Utilisez cette méthode pour déterminer si deux structures différentes FORMATETC retournent les mêmes données, en supprimant la nécessité d’un rendu en double.

public:
 int GetCanonicalFormatEtc(System::Runtime::InteropServices::ComTypes::FORMATETC % formatIn, [Runtime::InteropServices::Out] System::Runtime::InteropServices::ComTypes::FORMATETC % formatOut);
public int GetCanonicalFormatEtc(ref System.Runtime.InteropServices.ComTypes.FORMATETC formatIn, out System.Runtime.InteropServices.ComTypes.FORMATETC formatOut);
abstract member GetCanonicalFormatEtc : FORMATETC * FORMATETC -> int
Public Function GetCanonicalFormatEtc (ByRef formatIn As FORMATETC, ByRef formatOut As FORMATETC) As Integer

Paramètres

formatIn
FORMATETC

Pointeur vers une FORMATETC structure, passée par référence, qui définit le format, le moyen et l’appareil cible que l’appelant souhaite utiliser pour récupérer des données dans un appel ultérieur, tel que GetData(FORMATETC, STGMEDIUM). Le TYMED membre n’est pas significatif dans ce cas et doit être ignoré.

formatOut
FORMATETC

Lorsque cette méthode est retournée, contient un pointeur vers une FORMATETC structure qui contient les informations les plus générales possibles pour un rendu spécifique, ce qui le rend canoniquement équivalent à formatetcIn. L’appelant doit allouer cette structure et la GetCanonicalFormatEtc(FORMATETC, FORMATETC) méthode doit renseigner les données. Pour récupérer des données dans un appel suivant tel que GetData(FORMATETC, STGMEDIUM), l’appelant utilise la valeur formatOutfournie , sauf si la valeur fournie est null. Cette valeur est null si la méthode retourne DATA_S_SAMEFORMATETC. Le TYMED membre n’est pas significatif dans ce cas et doit être ignoré. Ce paramètre est passé non initialisé.

Retours

Int32

Cette méthode prend en charge les valeurs de retour standard E_INVALIDARG, E_UNEXPECTED et E_OUTOFMEMORY, ainsi que les éléments suivants :

Valeur Description
S_OK La structure retournée FORMATETC est différente de celle qui a été passée.
DATA_S_SAMEFORMATETC Les FORMATETC structures sont identiques et null sont retournées dans le formatOut paramètre.
DV_E_LINDEX Il existe une valeur non valide pour lindex; actuellement, seul -1 est pris en charge.
DV_E_FORMATETC Il existe une valeur non valide pour le formatIn paramètre.
OLE_E_NOTRUNNING L’application n’est pas en cours d’exécution.

Remarques

Pour plus d’informations, consultez la méthode IDataObject ::GetCanonicalFormatEtc.

S’applique à