Método ClipboardObject.IDataObject.GetCanonicalFormatEtc

Artigo
05/17/2015

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

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

Sintaxe

'Declaração
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 não oferece suporte a implementações explícitas da interface.

Parâmetros

formatIn
Tipo: FORMATETC%

Uma referência a uma estrutura de FORMATETC , passada por referência, que define o formato, o meio, e o dispositivo de destino que o chamador deseja usar para recuperar dados em uma chamada subsequente, como o IDataObject.GetData. O membro de tymed não é significativo nesse caso e deve ser ignorado.

formatOut
Tipo: FORMATETC%

Quando esse método retorna, este parâmetro contém um ponteiro para a estrutura de FORMATETC que contém as informações mais geral possível para uma renderização específica, tornando-o canônica o equivalente a pformatectIn. O chamador deve atribuir essa estrutura, e o método de GetCanonicalFormatEtc deve preencher os dados. Para recuperar dados em uma chamada subsequente, como o IDataObject.GetData, o chamador o valor fornecido de pformatetcOut, a menos que o valor fornecido é nulluma referência nula (Nothing no Visual Basic). Esse valor é zero se o método retorna DATA_S_SAMEFORMATETC. O membro de tymed não é significativo nesse caso e deve ser ignorado. Este parâmetro é passado não inicializado.

Valor de retorno

Tipo: Int32
Esse método oferece suporte aos valores de retorno padrão E_INVALIDARG, E_UNEXPECTED, e E_OUTOFMEMORY, bem como o seguinte:

Valor	Descrição
S_OK	A estrutura de FORMATETC retornado é diferente de aquele que foi passada.
DATA_S_SAMEFORMATETC	As estruturas de FORMATETC são as mesmas e uma referência nula é retornada no parâmetro de formatOut .
DV_E_LINDEX	Há um valor inválido para lindex; atualmente, somente -1 são suportados.
DV_E_FORMATETC	Há um valor válido para o parâmetro de formatIn .
OLE_E_NOTRUNNING	O aplicativo não está sendo executado.

Implementações

IDataObject.GetCanonicalFormatEtc(FORMATETC, FORMATETC)

Comentários

Este método delega a chamada para o GetCanonicalFormatEtc correspondente do System.Runtime.InteropServices.ComTypes , supondo que o objeto da área de transferência está envolvendo IDataObjectexistente.

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiável.

Consulte também

Referência

ClipboardObject Classe

Namespace Microsoft.VisualStudio.Data.Framework

Partilhar via