Fungsi EnumClipboardFormats (winuser.h)

Artikel
03/13/2024

Menghitung format data yang saat ini tersedia di clipboard.

Format data Clipboard disimpan dalam daftar yang diurutkan. Untuk melakukan enumerasi format data clipboard, Anda melakukan serangkaian panggilan ke fungsi EnumClipboardFormats . Untuk setiap panggilan, parameter format menentukan format clipboard yang tersedia, dan fungsi mengembalikan format clipboard berikutnya yang tersedia.

Sintaks

UINT EnumClipboardFormats(
  [in] UINT format
);

Parameter

[in] format

Jenis: UINT

Format clipboard yang diketahui tersedia.

Untuk memulai enumerasi format clipboard, atur format ke nol. Ketika format adalah nol, fungsi mengambil format clipboard pertama yang tersedia. Untuk panggilan berikutnya selama enumerasi, atur format ke hasil panggilan EnumClipboardFormats sebelumnya.

Nilai kembali

Jenis: UINT

Jika fungsi berhasil, nilai yang dikembalikan adalah format clipboard yang mengikuti format yang ditentukan, yaitu format clipboard berikutnya yang tersedia.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError. Jika clipboard tidak terbuka, fungsi gagal.

Jika tidak ada lagi format clipboard untuk dijumlahkan, nilai yang dikembalikan adalah nol. Dalam hal ini, fungsi GetLastError mengembalikan nilai ERROR_SUCCESS. Ini memungkinkan Anda membedakan antara kegagalan fungsi dan akhir enumerasi.

Keterangan

Anda harus membuka papan klip sebelum menghitung formatnya. Gunakan fungsi OpenClipboard untuk membuka clipboard. Fungsi EnumClipboardFormats gagal jika clipboard tidak terbuka.

Fungsi EnumClipboardFormats menghitung format dalam urutan penempatannya pada clipboard. Jika Anda menyalin informasi ke clipboard, tambahkan objek clipboard secara berurutan dari format clipboard yang paling deskriptif ke format clipboard yang paling tidak deskriptif. Jika Anda menempelkan informasi dari clipboard, ambil format clipboard pertama yang dapat Anda tangani. Itu akan menjadi format clipboard paling deskriptif yang dapat Anda tangani.

Sistem menyediakan konversi jenis otomatis untuk format clipboard tertentu. Dalam kasus format seperti itu, fungsi ini menghitung format yang ditentukan, lalu menghitung format yang dapat dikonversi. Untuk informasi selengkapnya, lihat Format Clipboard Standar dan Format Clipboard Yang Disintesis.

Contoh

Misalnya, lihat Contoh Penampil Clipboard.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	winuser.h (sertakan Windows.h)
Pustaka	User32.lib
DLL	User32.dll
Set API	ext-ms-win-ntuser-misc-l1-5-1 (diperkenalkan dalam Windows 10, versi 10.0.14393)