Fungsi GetWindowTextLengthA (winuser.h)

Artikel
2024-11-20

Mengambil panjang, dalam karakter, dari teks bilah judul jendela yang ditentukan (jika jendela memiliki bilah judul). Jika jendela yang ditentukan adalah kontrol, fungsi mengambil panjang teks dalam kontrol. Namun, GetWindowTextLength tidak dapat mengambil panjang teks kontrol edit di aplikasi lain.

Sintaksis

int GetWindowTextLengthA(
  [in] HWND hWnd
);

Parameter

[in] hWnd

Jenis: HWND

Handel ke jendela atau kontrol.

Mengembalikan nilai

Jenis: int

Jika fungsi berhasil, nilai yang dikembalikan adalah panjangnya, dalam karakter, dari teks. Dalam kondisi tertentu, nilai ini mungkin lebih besar dari panjang teks (lihat Keterangan).

Jika jendela tidak memiliki teks, nilai yang dikembalikan adalah nol.

Kegagalan fungsi ditunjukkan oleh nilai pengembalian nol dan hasil GetLastError yang bukan nol.

Nota

Fungsi ini tidak menghapus informasi kesalahan terbaru. Untuk menentukan keberhasilan atau kegagalan, hapus informasi kesalahan terbaru dengan memanggil SetLastError dengan 0, lalu panggil GetLastError.

Komentar

Jika jendela target dimiliki oleh proses saat ini, GetWindowTextLength menyebabkan pesan WM_GETTEXTLENGTH dikirim ke jendela atau kontrol yang ditentukan.

Dalam kondisi tertentu, fungsi GetWindowTextLength dapat mengembalikan nilai yang lebih besar dari panjang teks aktual. Ini terjadi dengan campuran ANSI dan Unicode tertentu, dan disebabkan oleh sistem yang memungkinkan adanya kemungkinan karakter set karakter byte ganda (DBCS) dalam teks. Namun, nilai yang dikembalikan akan selalu setidaknya sebesar panjang aktual teks; Anda dengan demikian selalu dapat menggunakannya untuk memandu alokasi buffer. Perilaku ini dapat terjadi ketika aplikasi menggunakan fungsi ANSI dan dialog umum, yang menggunakan Unicode. Ini juga dapat terjadi ketika aplikasi menggunakan versi ANSI GetWindowTextLength dengan jendela yang prosedur jendelanya adalah Unicode, atau versi Unicode GetWindowTextLength dengan jendela yang prosedur jendelanya adalah ANSI. Untuk informasi selengkapnya tentang fungsi ANSI dan ANSI, lihat Konvensi untuk Prototipe Fungsi.

Untuk mendapatkan panjang teks yang tepat, gunakan WM_GETTEXT, LB_GETTEXT, atau pesan CB_GETLBTEXT, atau fungsi GetWindowText .

Nota

Header winuser.h mendefinisikan GetWindowTextLength 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-window-l1-1-1 (diperkenalkan di Windows 8.1)