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

2024-11-20

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

Синтаксис

UINT RegisterClipboardFormatA(
  [in] LPCSTR lpszFormat
);

Параметры

[in] lpszFormat

Тип: LPCTSTR

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

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

Тип: UINT

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

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

Замечания

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

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

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

Примеры

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

Заметка

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

Требования

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