Metode IActionProgress::UpdateText (shobjidl_core.h)
Dipanggil jika teks deskriptif yang terkait dengan tindakan akan diubah.
Sintaks
HRESULT UpdateText(
[in] SPTEXT sptext,
[in] LPCWSTR pszText,
[in] BOOL fMayCompact
);
Parameter
[in] sptext
Jenis: SPTEXT
Nilai yang menentukan jenis teks yang ditampilkan. Lihat SPTEXT untuk nilai yang dapat diterima.
[in] pszText
Jenis: LPCWSTR
Penunjuk ke string karakter lebar untuk ditampilkan.
[in] fMayCompact
Jenis: BOOL
Nilai yang menentukan apakah akan memperbolehkan string teks dikompresi agar pas dengan ruang yang tersedia di layar.
Nilai kembali
Jenis: HRESULT
Mengembalikan S_OK jika berhasil, atau nilai kesalahan sebaliknya.
Keterangan
Kelas yang menerapkan metode ini harus menginterpretasikan nilai sptext dan fMayCompact dalam konteks tindakan yang dilakukan dan UI yang menunjukkan kemajuan kepada pengguna. Nilai sptext dapat digunakan untuk membedakan antara baris teks yang dapat diubah. Seringkali, nilai fMayCompact mengacu pada apakah string teks dapat dipotong dengan elipsis (...) untuk menghemat ruang layar.
Persyaratan
| Persyaratan | Nilai |
|---|---|
| Klien minimum yang didukung | Windows XP [hanya aplikasi desktop] |
| Server minimum yang didukung | Windows Server 2003 [hanya aplikasi desktop] |
| Target Platform | Windows |
| Header | shobjidl_core.h (termasuk Shobjidl.h) |
| DLL | Shobjidl.idl |