Функция GetClipboardFormatNameA (winuser.h)

  • Статья

Извлекает из буфера обмена имя указанного зарегистрированного формата. Функция копирует имя в указанный буфер.

Синтаксис

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

Параметры

[in] format

Тип: UINT

Тип извлекаемого формата. Этот параметр не должен указывать стандартные форматы буфера обмена.

[out] lpszFormatName

Тип: LPTSTR

Буфер, который получает имя формата.

[in] cchMaxCount

Тип: int

Максимальная длина строки в символах, копируемых в буфер. Если имя превышает это ограничение, оно усекается.

Возвращаемое значение

Тип: int

Если функция выполняется успешно, возвращаемое значение равно длине строки, скопированной в буфер, в символах.

Если функция завершается сбоем, возвращаемое значение равно нулю, указывая, что запрошенный формат не существует или является предопределенным. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Комментарии

Вопросы безопасности

Неправильное использование этой функции может поставить под угрозу безопасность программы. Например, неправильное вычисление правильного размера буфера lpszFormatName , особенно если приложение используется в версиях ANSI и Юникод, может привести к переполнению буфера. Кроме того, обратите внимание, что строка усекается, если она длиннее параметра cchMaxCount , что может привести к потере информации.

Примеры

Пример см. в разделе Пример средства просмотра буфера обмена.

Примечание

Заголовок winuser.h определяет GetClipboardFormatName в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование Значение
Минимальная версия клиента Windows 2000 Professional [только классические приложения]
Минимальная версия сервера Windows 2000 Server [только классические приложения]
Целевая платформа Windows
Header winuser.h (включая Windows.h)
Библиотека User32.lib
DLL User32.dll
Набор API ext-ms-win-ntuser-misc-l1-1-0 (представлено в Windows 8)

См. также раздел

Буфер обмена

Основные понятия

EnumClipboardFormats

Справочные материалы

RegisterClipboardFormat