enumClipboardFormats 函数 (winuser.h)

枚举剪贴板上当前可用的数据格式。

剪贴板数据格式存储在有序列表中。 若要执行剪贴板数据格式的枚举,需要对 EnumClipboardFormats 函数进行一系列调用。 对于每次调用, format 参数指定可用的剪贴板格式,函数返回下一个可用的剪贴板格式。

语法

UINT EnumClipboardFormats(
  [in] UINT format
);

参数

[in] format

类型: UINT

已知可用的剪贴板格式。

若要启动剪贴板格式的枚举,请将 格式 设置为零。 当 format 为零时,函数将检索第一个可用的剪贴板格式。 对于枚举期间的后续调用,请将 格式 设置为上一个 EnumClipboardFormats 调用的结果。

返回值

类型: UINT

如果函数成功,则返回值是遵循指定格式的剪贴板格式,即下一个可用的剪贴板格式。

如果函数失败,则返回值为零。 要获得更多的错误信息,请调用 GetLastError。 如果剪贴板未打开,函数将失败。

如果没有其他要枚举的剪贴板格式,则返回值为零。 在这种情况下, GetLastError 函数 ERROR_SUCCESS返回值。 这使你可以区分函数失败和枚举结束。

注解

在枚举剪贴板格式之前,必须打开剪贴板。 使用 OpenClipboard 函数打开剪贴板。 如果剪贴板未打开, 则 EnumClipboardFormats 函数失败。

EnumClipboardFormats 函数按格式放置在剪贴板上的顺序枚举格式。 如果要将信息复制到剪贴板,请按从最具描述性剪贴板格式到描述性最低的剪贴板格式的顺序添加剪贴板对象。 如果要粘贴剪贴板中的信息,请检索可以处理的第一种剪贴板格式。 这是可以处理的最具描述性的剪贴板格式。

系统为某些剪贴板格式提供自动类型转换。 对于此类格式,此函数枚举指定的格式,然后枚举可以转换为的格式。 有关详细信息,请参阅 标准剪贴板格式合成剪贴板格式

示例

有关示例,请参阅 剪贴板查看器的示例

要求

要求
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 winuser.h (包括 Windows.h)
Library User32.lib
DLL User32.dll
API 集 在 (Windows 10 版本 10.0.14393 中引入的 ext-ms-win-ntuser-misc-l1-5-1)

另请参阅

剪贴板

概念性

CountClipboardFormats

OpenClipboard

引用

RegisterClipboardFormat