DataObject.IDataObject.GetCanonicalFormatEtc(FORMATETC, FORMATETC) Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
virtual int System.Runtime.InteropServices.ComTypes.IDataObject.GetCanonicalFormatEtc(System::Runtime::InteropServices::ComTypes::FORMATETC % pformatetcIn, [Runtime::InteropServices::Out] System::Runtime::InteropServices::ComTypes::FORMATETC % pformatetcOut) = System::Runtime::InteropServices::ComTypes::IDataObject::GetCanonicalFormatEtc;
int IDataObject.GetCanonicalFormatEtc (ref System.Runtime.InteropServices.ComTypes.FORMATETC pformatetcIn, out System.Runtime.InteropServices.ComTypes.FORMATETC pformatetcOut);
abstract member System.Runtime.InteropServices.ComTypes.IDataObject.GetCanonicalFormatEtc : FORMATETC * FORMATETC -> int
override this.System.Runtime.InteropServices.ComTypes.IDataObject.GetCanonicalFormatEtc : FORMATETC * FORMATETC -> int
Function GetCanonicalFormatEtc (ByRef pformatetcIn As FORMATETC, ByRef pformatetcOut As FORMATETC) As Integer Implements IDataObject.GetCanonicalFormatEtc
Parâmetros
- pformatetcIn
- FORMATETC
Um ponteiro para uma estrutura FORMATETC, passado por referência, que define o formato, o meio e o dispositivo de destino que o chamador gostaria de usar para recuperar dados em uma chamada subsequente, como GetData(FORMATETC, STGMEDIUM). O membro TYMED não é significativo nesse caso e deve ser ignorado.
- pformatetcOut
- FORMATETC
Quando esse método retorna, 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 esta estrutura e o método GetCanonicalFormatEtc(FORMATETC, FORMATETC) deve preencher os dados. Para recuperar dados em uma chamada subsequente, como GetData(FORMATETC, STGMEDIUM), o chamador usa o valor fornecido de formatOut
, a menos que o valor fornecido seja null
. Esse valor será null
se o método retornar DATA_S_SAMEFORMATETC
. O membro TYMED não é significativo nesse caso e deve ser ignorado. Este parâmetro é passado não inicializado.
Retornos
Este método é compatível com os valores retornados padrão E_INVALIDARG, E_UNEXPECTED e E_OUTOFMEMORY e também com os seguintes:
Valor | Descrição |
---|---|
S_OK | A estrutura FORMATETC retornada é diferente da que foi passada. |
DATA_S_SAMEFORMATETC | As estruturas FORMATETC são iguais e null é retornado no parâmetro formatOut .
|
DV_E_LINDEX | Há um valor inválido para lindex; no momento, apenas -1 é compatível. |
DV_E_FORMATETC | Há um valor inválido para o parâmetro pFormatetc .
|
OLE_E_NOTRUNNING | O aplicativo não está em execução. |
Implementações
Comentários
Este membro é uma implementação do membro de interface explícita. Ele só pode ser usado quando o DataObject é convertido em uma IDataObject interface.