IDataObject.GetCanonicalFormatEtc(FORMATETC, FORMATETC) Método

Definição

Namespace:
System.Runtime.InteropServices.ComTypes
Assembly:
System.dll
Assembly:
netstandard.dll

Fornece uma estrutura padrão FORMATETC que é logicamente equivalente a uma estrutura mais complexa. Use esse método para determinar se duas estruturas diferentes FORMATETC retornariam os mesmos dados, removendo a necessidade de renderização duplicada.

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

Parâmetros

formatIn
FORMATETC

Um ponteiro para uma FORMATETC estrutura, passada por referência, que define o formato, o dispositivo médio e de destino que o chamador gostaria de usar para recuperar dados em uma chamada subsequente, como GetData(FORMATETC, STGMEDIUM). O TYMED membro não é significativo nesse caso e deve ser ignorado.

formatOut
FORMATETC

Quando esse método é retornado, contém um ponteiro para uma FORMATETC estrutura que contém as informações mais gerais possíveis para uma renderização específica, tornando-o canonicamente equivalente a formatetcIn. O chamador deve alocar essa estrutura e o GetCanonicalFormatEtc(FORMATETC, FORMATETC) método deve preencher os dados. Para recuperar dados em uma chamada subsequente, como GetData(FORMATETC, STGMEDIUM), o chamador usa o valor fornecido, formatOuta menos que o valor fornecido seja null. Esse valor será null se o método retornar DATA_S_SAMEFORMATETC. O TYMED membro não é significativo nesse caso e deve ser ignorado. Esse parâmetro é passado sem inicialização.

Retornos

Int32

Esse método dá suporte aos valores retornados padrão E_INVALIDARG, E_UNEXPECTED e E_OUTOFMEMORY, bem como o seguinte:

Valor Descrição
S_OK A estrutura retornada FORMATETC é diferente daquela que foi passada.
DATA_S_SAMEFORMATETC As FORMATETC estruturas são as mesmas e null são retornadas no formatOut parâmetro.
DV_E_LINDEX Há um valor inválido para lindex; atualmente, há suporte apenas -1.
DV_E_FORMATETC Há um valor inválido para o formatIn parâmetro.
OLE_E_NOTRUNNING O aplicativo não está em execução.

Comentários

Para obter mais informações, consulte o método IDataObject::GetCanonicalFormatEtc.

Aplica-se a