Fungsi TextOutA (wingdi.h)

Artikel
03/09/2024

Fungsi TextOut menulis string karakter di lokasi yang ditentukan, menggunakan font, warna latar belakang, dan warna teks yang saat ini dipilih.

Sintaks

BOOL TextOutA(
  [in] HDC    hdc,
  [in] int    x,
  [in] int    y,
  [in] LPCSTR lpString,
  [in] int    c
);

Parameter

[in] hdc

Handel ke konteks perangkat.

[in] x

Koordinat x, dalam koordinat logis, dari titik referensi yang digunakan sistem untuk menyelaraskan string.

[in] y

Koordinat y, dalam koordinat logis, dari titik referensi yang digunakan sistem untuk menyelaraskan string.

[in] lpString

Penunjuk ke string yang akan digambar. String tidak perlu dihentikan nol, karena cchString menentukan panjang string.

[in] c

Panjang string yang ditujukan ke oleh lpString, dalam karakter.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol.

Keterangan

Interpretasi titik referensi tergantung pada mode perataan teks saat ini. Aplikasi dapat mengambil mode ini dengan memanggil fungsi GetTextAlign ; aplikasi dapat mengubah mode ini dengan memanggil fungsi SetTextAlign . Anda bisa menggunakan nilai berikut untuk perataan teks. Hanya satu bendera yang dapat dipilih dari bendera yang memengaruhi perataan horizontal dan vertikal. Selain itu, hanya salah satu dari dua bendera yang mengubah posisi saat ini yang dapat dipilih.

Istilah	Deskripsi
TA_BASELINE	Titik referensi akan berada di baris dasar teks.
TA_BOTTOM	Titik referensi akan berada di tepi bawah persegi panjang pembatas.
TA_TOP	Titik referensi akan berada di tepi atas persegi panjang pembatas.
TA_CENTER	Titik referensi akan diratakan secara horizontal dengan tengah persegi panjang pembatas.
TA_LEFT	Titik referensi akan berada di tepi kiri persegi panjang pembatas.
TA_RIGHT	Titik referensi akan berada di tepi kanan persegi panjang pembatas.
TA_NOUPDATECP	Posisi saat ini tidak diperbarui setelah setiap panggilan output teks. Titik referensi diteruskan ke fungsi output teks.
TA_RTLREADING	Windows edisi bahasa Timur Tengah: Teks ditata dalam urutan baca kanan ke kiri, dibandingkan dengan urutan default kiri ke kanan. Ini hanya berlaku ketika font yang dipilih ke dalam konteks perangkat adalah Ibrani atau Arab.
TA_UPDATECP	Posisi saat ini diperbarui setelah setiap panggilan output teks. Posisi saat ini digunakan sebagai titik referensi.

Secara default, posisi saat ini tidak digunakan atau diperbarui oleh fungsi ini. Namun, aplikasi dapat memanggil fungsi SetTextAlign dengan parameter fMode diatur ke TA_UPDATECP untuk mengizinkan sistem menggunakan dan memperbarui posisi saat ini setiap kali aplikasi memanggil TextOut untuk konteks perangkat tertentu. Ketika bendera ini diatur, sistem mengabaikan parameter nXStart dan nYStart pada panggilan TextOut berikutnya.

Saat fungsi TextOut ditempatkan di dalam tanda kurung jalur, sistem menghasilkan jalur untuk teks TrueType yang menyertakan setiap karakter ditambah kotak karakternya. Wilayah yang dihasilkan adalah kotak karakter dikurangi teks, bukan teks itu sendiri. Anda dapat memperoleh wilayah yang diapit oleh kerangka teks TrueType dengan mengatur mode latar belakang menjadi transparan sebelum menempatkan fungsi TextOut di tanda kurung jalur. Berikut ini adalah kode sampel yang menunjukkan prosedur ini.


// Obtain the window's client rectangle 
GetClientRect(hwnd, &r);

// THE FIX: by setting the background mode 
// to transparent, the region is the text itself 
// SetBkMode(hdc, TRANSPARENT); 

// Bracket begin a path 
BeginPath(hdc);

// Send some text out into the world 
TCHAR text[ ] = "Defenestration can be hazardous";
TextOut(hdc,r.left,r.top,text, ARRAYSIZE(text));

// Bracket end a path 
EndPath(hdc);

// Derive a region from that path 
SelectClipPath(hdc, RGN_AND);

// This generates the same result as SelectClipPath() 
// SelectClipRgn(hdc, PathToRegion(hdc)); 

// Fill the region with grayness 
FillRect(hdc, &r, GetStockObject(GRAY_BRUSH));

Contoh

Misalnya, lihat Menghitung Font yang Diinstal.

Catatan

Header wingdi.h mendefinisikan TextOut 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	wingdi.h (sertakan Windows.h)
Pustaka	Gdi32.lib
DLL	Gdi32.dll