Share via


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)
程式庫 User32.lib
Dll User32.dll
API 集合 ext-ms-win-ntuser-misc-l1-5-1 (於 Windows 10 10.0.14393 版)

另請參閱

剪貼簿

概念

CountClipboardFormats

OpenClipboard

參考

RegisterClipboardFormat