IDataObject.GetCanonicalFormatEtc(FORMATETC, FORMATETC) Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
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
Puntero a una FORMATETC estructura, pasada por referencia, que define el formato, el medio y el dispositivo de destino que el autor de la llamada desea usar para recuperar datos en una llamada posterior, como GetData(FORMATETC, STGMEDIUM). El TYMED miembro no es significativo en este caso y debe omitirse.
- formatOut
- FORMATETC
Cuando este método vuelve, contiene un puntero a una FORMATETC estructura que contiene la información más general posible para una representación específica, lo que hace que sea canónicamente equivalente a formatetcIn. El autor de la llamada debe asignar esta estructura y el GetCanonicalFormatEtc(FORMATETC, FORMATETC) método debe rellenar los datos. Para recuperar datos en una llamada posterior, como GetData(FORMATETC, STGMEDIUM), el autor de la llamada usa el valor proporcionado de formatOut, a menos que el valor proporcionado sea null. Este valor es null si el método devuelve DATA_S_SAMEFORMATETC. El TYMED miembro no es significativo en este caso y debe omitirse. Este parámetro se pasa sin inicializar.
Devoluciones
Este método admite los valores devueltos estándar E_INVALIDARG, E_UNEXPECTED y E_OUTOFMEMORY, así como lo siguiente:
| Valor | Descripción |
|---|---|
| S_OK | La estructura devuelta FORMATETC es diferente de la que se pasó. |
| DATA_S_SAMEFORMATETC | Las FORMATETC estructuras son las mismas y null se devuelven en el formatOut parámetro .
|
| DV_E_LINDEX | Hay un valor no válido para lindex; actualmente, solo se admite -1. |
| DV_E_FORMATETC | Hay un valor no válido para el formatIn parámetro .
|
| OLE_E_NOTRUNNING | La aplicación no se está ejecutando. |
Comentarios
Para obtener más información, vea Método IDataObject::GetCanonicalFormatEtc.