Função EnumClipboardFormats (winuser.h)

Artigo
03/15/2023

Enumera os formatos de dados disponíveis atualmente na área de transferência.

Os formatos de dados da área de transferência são armazenados em uma lista ordenada. Para executar uma enumeração de formatos de dados da área de transferência, você faz uma série de chamadas para a função EnumClipboardFormats . Para cada chamada, o parâmetro de formato especifica um formato de área de transferência disponível e a função retorna o próximo formato de área de transferência disponível.

Sintaxe

UINT EnumClipboardFormats(
  [in] UINT format
);

Parâmetros

[in] format

Tipo: UINT

Um formato de área de transferência que é conhecido por estar disponível.

Para iniciar uma enumeração de formatos de área de transferência, defina o formato como zero. Quando o formato é zero, a função recupera o primeiro formato de área de transferência disponível. Para chamadas subsequentes durante uma enumeração, defina o formato como o resultado da chamada EnumClipboardFormats anterior.

Retornar valor

Tipo: UINT

Se a função for bem-sucedida, o valor retornado será o formato da área de transferência que segue o formato especificado, ou seja, o próximo formato de área de transferência disponível.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError. Se a área de transferência não estiver aberta, a função falhará.

Se não houver mais formatos de área de transferência para enumerar, o valor retornado será zero. Nesse caso, a função GetLastError retorna o valor ERROR_SUCCESS. Isso permite distinguir entre a falha de função e o fim da enumeração.

Comentários

Você deve abrir a área de transferência antes de enumerar seus formatos. Use a função OpenClipboard para abrir a área de transferência. A função EnumClipboardFormats falhará se a área de transferência não estiver aberta.

A função EnumClipboardFormats enumera formatos na ordem em que foram colocados na área de transferência. Se você estiver copiando informações para a área de transferência, adicione objetos de área de transferência na ordem do formato de área de transferência mais descritivo para o formato de área de transferência menos descritivo. Se você estiver colando informações da área de transferência, recupere o primeiro formato de área de transferência que você pode manipular. Esse será o formato de área de transferência mais descritivo que você pode manipular.

O sistema fornece conversões automáticas de tipo para determinados formatos de área de transferência. No caso desse formato, essa função enumera o formato especificado e, em seguida, enumera os formatos nos quais ela pode ser convertida. Para obter mais informações, consulte Formatos de área de transferência padrão e formatos de área de transferência sintetizados.

Exemplos

Para obter um exemplo, consulte Exemplo de um Visualizador da Área de Transferência.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winuser.h (inclua Windows.h)
Biblioteca	User32.lib
DLL	User32.dll
Conjunto de APIs	ext-ms-win-ntuser-misc-l1-5-1 (introduzido no Windows 10, versão 10.0.14393)