Fungsi GetClipboardFormatNameA (winuser.h)

  • Artikel

Mengambil dari clipboard nama format terdaftar yang ditentukan. Fungsi menyalin nama ke buffer yang ditentukan.

Sintaks

int GetClipboardFormatNameA(
  [in]  UINT  format,
  [out] LPSTR lpszFormatName,
  [in]  int   cchMaxCount
);

Parameter

[in] format

Jenis: UINT

Jenis format yang akan diambil. Parameter ini tidak boleh menentukan format clipboard yang telah ditentukan sebelumnya.

[out] lpszFormatName

Jenis: LPTSTR

Buffer yang akan menerima nama format.

[in] cchMaxCount

Jenis: int

Panjang maksimum, dalam karakter, dari string yang akan disalin ke buffer. Jika nama melebihi batas ini, nama tersebut akan dipotok.

Nilai kembali

Jenis: int

Jika fungsi berhasil, nilai yang dikembalikan adalah panjang, dalam karakter, dari string yang disalin ke buffer.

Jika fungsi gagal, nilai yang dikembalikan adalah nol, menunjukkan bahwa format yang diminta tidak ada atau telah ditentukan sebelumnya. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Pertimbangan Keamanan

Menggunakan fungsi ini secara tidak benar dapat membahayakan keamanan program Anda. Misalnya, salah menghitung ukuran buffer lpszFormatName yang tepat, terutama ketika aplikasi digunakan dalam versi ANSI dan Unicode, dapat menyebabkan luapan buffer. Selain itu, perhatikan bahwa string dipotok jika lebih panjang dari parameter cchMaxCount , yang dapat menyebabkan hilangnya informasi.

Contoh

Misalnya, lihat Contoh Penampil Clipboard.

Catatan

Header winuser.h mendefinisikan GetClipboardFormatName sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta pra-prosesor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

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-1-0 (diperkenalkan dalam Windows 8)

Lihat juga

Clipboard

Konseptual

EnumClipboardFormats

Referensi

RegisterClipboardFormat