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

Статья
08/27/2023

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

Синтаксис

UINT RegisterClipboardFormatW(
  [in] LPCWSTR 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)