Fungsi SetClipboardData (winuser.h)

Artikel
03/08/2023

Menempatkan data pada clipboard dalam format clipboard tertentu. Jendela harus menjadi pemilik clipboard saat ini, dan aplikasi harus memanggil fungsi OpenClipboard . (Saat menanggapi pesan WM_RENDERFORMAT , pemilik clipboard tidak boleh memanggil OpenClipboard sebelum memanggil SetClipboardData.)

Sintaks

HANDLE SetClipboardData(
  [in]           UINT   uFormat,
  [in, optional] HANDLE hMem
);

Parameter

[in] uFormat

Jenis: UINT

Format clipboard. Parameter ini dapat berupa format terdaftar atau salah satu format clipboard standar. Untuk informasi selengkapnya, lihat Format Clipboard Standar dan Format Papan Klip Terdaftar.

[in, optional] hMem

Jenis: HANDEL

Handel ke data dalam format yang ditentukan. Parameter ini dapat berupa NULL, menunjukkan bahwa jendela menyediakan data dalam format clipboard yang ditentukan (merender format) berdasarkan permintaan; ini dikenal sebagai penyajian tertunda. Jika jendela menunda penyajian, jendela harus memproses pesan WM_RENDERFORMAT dan WM_RENDERALLFORMATS .

Jika SetClipboardData berhasil, sistem memiliki objek yang diidentifikasi oleh parameter hMem . Aplikasi mungkin tidak menulis atau membebaskan data setelah kepemilikan ditransfer ke sistem, tetapi dapat mengunci dan membaca dari data sampai fungsi CloseClipboard dipanggil. (Memori harus dibuka kuncinya sebelum Papan Klip ditutup.) Jika parameter hMem mengidentifikasi objek memori, objek harus dialokasikan menggunakan fungsi dengan bendera GMEM_MOVEABLE .

Nilai kembali

Jenis: HANDEL

Jika fungsi berhasil, nilai yang dikembalikan adalah handel ke data.

Jika fungsi gagal, nilai yang dikembalikan adalah NULL. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Windows 8: Bitmap yang akan dibagikan dengan aplikasi Bursa Windows harus dalam format CF_BITMAP (bitmap yang bergantung pada perangkat).

Jika aplikasi memanggil SetClipboardData sebagai respons terhadap WM_RENDERFORMAT atau WM_RENDERALLFORMATS, aplikasi tidak boleh menggunakan handel setelah SetClipboardData dipanggil.

Jika aplikasi memanggil OpenClipboard dengan hwnd diatur ke NULL, EmptyClipboard mengatur pemilik clipboard ke NULL; ini menyebabkan SetClipboardData gagal.

Sistem melakukan konversi format data implisit antara format clipboard tertentu saat aplikasi memanggil fungsi GetClipboardData . Misalnya, jika format CF_OEMTEXT ada di clipboard, jendela dapat mengambil data dalam format CF_TEXT . Format pada clipboard dikonversi ke format yang diminta sesuai permintaan. Untuk informasi selengkapnya, lihat Format Clipboard Yang Disintesis.

Contoh

Misalnya, lihat Menyalin Informasi ke Clipboard.

Persyaratan


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 (termasuk Windows.h)
Pustaka	User32.lib
DLL	User32.dll
Set API	ext-ms-win-ntuser-misc-l1-2-0 (diperkenalkan di Windows 8.1)