Fungsi GetClipboardFormatNameA (winuser.h)

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

Sintaksis

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 salah satu format clipboard yang telah ditentukan sebelumnya.

[out] lpszFormatName

Jenis: LPTSTR

Buffer yang 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 dipotong.

Mengembalikan nilai

Jenis: int

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

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

Komentar

Pertimbangan Keamanan

Menggunakan fungsi ini salah dapat membahayakan keamanan program Anda. Misalnya, salah menghitung ukuran buffer lpszFormatName, terutama ketika aplikasi digunakan dalam versi ANSI dan Unicode, dapat menyebabkan luapan buffer. Perhatikan juga bahwa string dipotong jika lebih panjang dari parameter cchMaxCount, yang dapat menyebabkan hilangnya informasi.

Contoh

Misalnya, lihat Contoh Penampil Clipboard.

Nota

Header winuser.h mendefinisikan GetClipboardFormatName sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprosedur 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

Syarat	Nilai
klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Platform Target	Windows
Header	winuser.h (termasuk Windows.h)
Pustaka	User32.lib
DLL	User32.dll
set API	ext-ms-win-ntuser-misc-l1-1-0 (diperkenalkan di Windows 8)

Lihat juga

Clipboard

Konseptual

EnumClipboardFormats

Referensi

RegisterClipboardFormat