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

Статья
08/27/2023

Регистрирует новый формат буфера обмена. Затем этот формат можно использовать в качестве допустимого формата буфера обмена.

Синтаксис

UINT RegisterClipboardFormatA(
  [in] LPCSTR lpszFormat
);

Параметры

[in] lpszFormat

Тип: LPCTSTR

Имя нового формата.

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

Тип: UINT

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

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

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

Зарегистрированные форматы буфера обмена определяются значениями в диапазоне 0xC000 по 0xFFFF.

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

Примеры

Пример см. в разделе Регистрация формата буфера обмена.

Примечание

Заголовок winuser.h определяет RegisterClipboardFormat как псевдоним, который автоматически выбирает версию 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-2-0 (представлено в Windows 8.1)