Função RegisterClipboardFormatA (winuser.h)

Artigo
03/04/2024

Registra um novo formato de área de transferência. Esse formato pode ser usado como um formato de área de transferência válido.

Sintaxe

UINT RegisterClipboardFormatA(
  [in] LPCSTR lpszFormat
);

Parâmetros

[in] lpszFormat

Tipo: LPCTSTR

O nome do novo formato.

Retornar valor

Tipo: UINT

Se a função for bem-sucedida, o valor retornado identificará o formato da área de transferência registrada.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Se já existir um formato registrado com o nome especificado, um novo formato não será registrado e o valor retornado identificará o formato existente. Isso permite que mais de um aplicativo copie e cole dados usando o mesmo formato de área de transferência registrado. Observe que a comparação de nomes de formato não diferencia maiúsculas de minúsculas.

Os formatos de área de transferência registrados são identificados por valores no intervalo 0xC000 até 0xFFFF.

Quando os formatos de área de transferência registrados são colocados ou recuperados da área de transferência, eles devem estar na forma de um valor HGLOBAL .

Exemplos

Para obter um exemplo, consulte Registrando um formato de área de transferência.

Observação

O cabeçalho winuser.h define RegisterClipboardFormat como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

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-2-0 (introduzido no Windows 8.1)