Функция GetClipboardFormatName извлекает из буфера обмена название заданного зарегистрированного формата. Функция копирует название в установленный буфер.
Синтаксис
int GetClipboardFormatName( UINT format, LPTSTR lpszFormatName, int cchMaxCount ); |
Параметры
format
[in] Задает тип формата, который извлекается. Этот параметр не должен задавать какой-либо из предопределенных форматов буфера обмена.lpszFormatName
[out] Указатель на буфер, который должен получить название формата.cchMaxCount
[in] Устанавливает максимальную длину строки, в TCHARs, которая копируется в буфер. Если название выходит за пределы этого ограничения, оно обрезается. Для версии ANSI этой функции, это - число байтов. Для расширенной символьной (Unicode) версии, это - число символов.Возвращаемые значения
Если функция завершается успешно, возвращаемое значение - длина, в TCHARs, строки, скопированной в буфер.
Если функция завершается ошибкой, величина возвращаемого значения - нуль, который указывает, что затребованный формат не существует или предопределен. Чтобы получить дополнительные сведения об ошибке, вызовите GetLastError.
Windows 95/98/Me: GetClipboardFormatNameW поддерживается программой Microsoft Layer for Unicode. Чтобы использовать ее, Вы должны добавить некоторые файлы к вашему приложению, как изложено в описании Microsoft Layer for Unicode для системы Windows 95/98/Me.
Замечания
|
Обратите внимание! на то, что неправильное использование этой функции может поставить под угрозу систему безопасности) вашей программы. Например, ошибка в процессе расчета надлежащего размера буфера lpszFormatName, особенно когда приложение используется и в ANSI и в Unicode версиях, может стать причиной переполнения буфера. Также, обратите внимание! и на то, что строка обрезается, если она длиннее, чем параметр cchMaxCount , что может привести к потере информации. |
Пример
Пример смотри в статье Пример Окна просмотра буфера обмена.
Смотри также
Обзор Буфер обмена, EnumClipboardFormats, RegisterClipboardFormat
|
Размещение и совместимость GetClipboardFormatName |
|
|
Windows. NET Server |
Да |
|
Windows XP |
Да |
|
Windows 2000 |
Да |
|
Windows NT |
Да версии 3.1 и выше |
|
Windows Me |
Да |
|
Windows 98 |
Да |
|
Windows 95 |
Да |
|
Используемая библиотека |
User32.lib |
|
Заголовочный файл |
|
|
- объявлено в |
Winuser.h |
|
- включено в |
Windows.h |
|
Unicode |
Нет |
|
Замечания по платформе |
Не имеется |