Função GetClipboardFormatNameA (winuser.h)

Recupera da área de transferência o nome do formato registrado especificado. A função copia o nome para o buffer especificado.

Sintaxe

int GetClipboardFormatNameA(
  [in]  UINT  format,
  [out] LPSTR lpszFormatName,
  [in]  int   cchMaxCount
);

Parâmetros

[in] format

Tipo: UINT

O tipo de formato a ser recuperado. Esse parâmetro não deve especificar nenhum dos formatos de área de transferência predefinidos.

[out] lpszFormatName

Tipo: LPTSTR

O buffer que deve receber o nome do formato.

[in] cchMaxCount

Tipo: int

O comprimento máximo, em caracteres, da cadeia de caracteres a ser copiada para o buffer. Se o nome exceder esse limite, ele será truncado.

Retornar valor

Tipo: int

Se a função for bem-sucedida, o valor retornado será o comprimento, em caracteres, da cadeia de caracteres copiada para o buffer.

Se a função falhar, o valor retornado será zero, indicando que o formato solicitado não existe ou é predefinido. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Considerações sobre segurança

Usar essa função incorretamente pode comprometer a segurança do programa. Por exemplo, calcular incorretamente o tamanho adequado do buffer lpszFormatName , especialmente quando o aplicativo é usado em versões ANSI e Unicode, pode causar um estouro de buffer. Além disso, observe que a cadeia de caracteres será truncada se for maior que o parâmetro cchMaxCount , o que pode levar à perda de informações.

Exemplos

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

Observação

O cabeçalho winuser.h define GetClipboardFormatName 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-1-0 (introduzido no Windows 8)

Confira também

Área de transferência

Conceitual

Enumclipboardformats

Referência

Registerclipboardformat