Fungsi CreateCaret (winuser.h)

Artikel
08/27/2023

Membuat bentuk baru untuk tanda sisipan sistem dan menetapkan kepemilikan tanda sisipan ke jendela yang ditentukan. Bentuk tanda sisipan bisa berupa garis, blok, atau bitmap.

Sintaks

BOOL CreateCaret(
  [in]           HWND    hWnd,
  [in, optional] HBITMAP hBitmap,
  [in]           int     nWidth,
  [in]           int     nHeight
);

Parameter

[in] hWnd

Jenis: HWND

Handel ke jendela yang memiliki tanda sisipan.

[in, optional] hBitmap

Jenis: HBITMAP

Handel ke bitmap yang menentukan bentuk tanda sisipan. Jika parameter ini NULL, tanda sisipannya padat. Jika parameter ini adalah (HBITMAP) 1, tanda sisipannya abu-abu. Jika parameter ini adalah handel bitmap, tanda sisipan adalah bitmap yang ditentukan. Handel bitmap harus dibuat oleh fungsi CreateBitmap, CreateDIBitmap, atau LoadBitmap .

Jika hBitmap adalah handel bitmap, CreateCaret mengabaikan parameter nWidth dan nHeight ; bitmap mendefinisikan lebar dan tingginya sendiri.

[in] nWidth

Jenis: int

Lebar tanda sisipan, dalam unit logis. Jika parameter ini nol, lebar diatur ke lebar batas jendela yang ditentukan sistem. Jika hBitmap adalah handel bitmap, CreateCaret mengabaikan parameter ini.

[in] nHeight

Jenis: int

Tinggi tanda sisipan, dalam unit logis. Jika parameter ini nol, tinggi diatur ke tinggi batas jendela yang ditentukan sistem. Jika hBitmap adalah handel bitmap, CreateCaret mengabaikan parameter ini.

Mengembalikan nilai

Jenis: BOOL

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

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

Keterangan

Parameter nWidth dan nHeight menentukan lebar dan tinggi tanda sisipan, dalam unit logis; lebar dan tinggi yang tepat, dalam piksel, bergantung pada mode pemetaan jendela.

CreateCaret secara otomatis menghancurkan bentuk tanda sisipan sebelumnya, jika ada, terlepas dari jendela yang memiliki tanda sisipan. Tanda sisipan disembunyikan sampai aplikasi memanggil fungsi ShowCaret untuk membuat tanda sisipan terlihat.

Sistem ini menyediakan satu tanda sisipan per antrean. Jendela harus membuat tanda sisipan hanya ketika memiliki fokus keyboard atau aktif. Jendela harus menghancurkan tanda sisipan sebelum kehilangan fokus keyboard atau menjadi tidak aktif.

Virtualisasi DPI

API ini tidak berpartisipasi dalam virtualisasi DPI. Parameter lebar dan tinggi ditafsirkan sebagai ukuran logis dalam hal jendela yang dimaksud. Utas panggilan tidak dipertimbangkan.

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-caret-l1-1-0 (diperkenalkan di Windows 8)