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

Статья
11/20/2024

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

Синтаксис

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 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winuser.h (включая Windows.h)
библиотеки	User32.lib
DLL	User32.dll
набор API	ext-ms-win-ntuser-misc-l1-1-0 (представлено в Windows 8)

См. также

буфер обмена

концептуальные

EnumClipboardFormats

Справочник

RegisterClipboardFormat

Поделиться через