Función EnumClipboardFormats (winuser.h)

Artículo
03/04/2024

Enumera los formatos de datos disponibles actualmente en el Portapapeles.

Los formatos de datos del Portapapeles se almacenan en una lista ordenada. Para realizar una enumeración de formatos de datos del Portapapeles, realice una serie de llamadas a la función EnumClipboardFormats . Para cada llamada, el parámetro format especifica un formato de Portapapeles disponible y la función devuelve el siguiente formato de Portapapeles disponible.

Sintaxis

UINT EnumClipboardFormats(
  [in] UINT format
);

Parámetros

[in] format

Tipo: UINT

Formato del Portapapeles que se sabe que está disponible.

Para iniciar una enumeración de formatos de Portapapeles, establezca el formato en cero. Cuando el formato es cero, la función recupera el primer formato de Portapapeles disponible. Para las llamadas posteriores durante una enumeración, establezca el formato en el resultado de la llamada anterior a EnumClipboardFormats .

Valor devuelto

Tipo: UINT

Si la función se ejecuta correctamente, el valor devuelto es el formato del Portapapeles que sigue al formato especificado, es decir, el siguiente formato de Portapapeles disponible.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError. Si el Portapapeles no está abierto, se produce un error en la función.

Si no hay más formatos de Portapapeles para enumerar, el valor devuelto es cero. En este caso, la función GetLastError devuelve el valor ERROR_SUCCESS. Esto permite distinguir entre el error de función y el final de la enumeración.

Comentarios

Debe abrir el Portapapeles antes de enumerar sus formatos. Use la función OpenClipboard para abrir el Portapapeles. Se produce un error en la función EnumClipboardFormats si el Portapapeles no está abierto.

La función EnumClipboardFormats enumera los formatos en el orden en que se colocaron en el Portapapeles. Si va a copiar información en el Portapapeles, agregue objetos del Portapapeles en orden desde el formato del Portapapeles más descriptivo al formato de Portapapeles menos descriptivo. Si pega información del Portapapeles, recupere el primer formato del Portapapeles que puede controlar. Será el formato más descriptivo del Portapapeles que puede controlar.

El sistema proporciona conversiones automáticas de tipos para determinados formatos del Portapapeles. En el caso de este formato, esta función enumera el formato especificado y, a continuación, enumera los formatos a los que se puede convertir. Para obtener más información, vea Formatos estándar del Portapapeles y Formatos de Portapapeles sintetizados.

Ejemplos

Para obtener un ejemplo, vea Ejemplo de un Visor de Portapapeles.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winuser.h (incluya Windows.h)
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-misc-l1-5-1 (introducido en Windows 10, versión 10.0.14393)