Função GetClipboardFormatNameA (winuser.h)

Artigo
11/20/2024

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.

Valor de retorno

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.

Observações

considerações sobre segurança

Usar essa função incorretamente pode comprometer a segurança do seu programa. Por exemplo, calcular incorretamente o tamanho adequado do buffer lpszFormatName, especialmente quando o aplicativo é usado nas 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 de Área de Transferência.

Nota

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 do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	winuser.h (inclua Windows.h)
biblioteca	User32.lib
de DLL	User32.dll
conjunto de API	ext-ms-win-ntuser-misc-l1-1-0 (introduzido no Windows 8)

Consulte também

de área de transferência

Conceitual

EnumClipboardFormats

de referência de

RegisterClipboardFormat

Compartilhar via