Metode ITextStoreAnchor::GetText (textstor.h)

Artikel
08/26/2023

Metode ITextStoreAnchor::GetText mengembalikan informasi tentang teks pada posisi jangkar tertentu. Metode ini mengembalikan teks yang terlihat dan tersembunyi dan menunjukkan apakah data yang disematkan dilampirkan ke teks.

Sintaks

HRESULT GetText(
  [in]  DWORD   dwFlags,
  [in]  IAnchor *paStart,
  [in]  IAnchor *paEnd,
  [out] WCHAR   *pchText,
  [in]  ULONG   cchReq,
  [out] ULONG   *pcch,
  [in]  BOOL    fUpdateAnchor
);

Parameter

[in] dwFlags

Tidak digunakan; harus nol.

[in] paStart

Menentukan posisi jangkar awal.

[in] paEnd

Menentukan posisi jangkar akhir. Jika NULL, null diperlakukan seolah-olah itu adalah jangkar yang diposisikan di bagian paling akhir aliran teks.

[out] pchText

Menentukan buffer untuk menerima teks. Mungkin NULL hanya ketika cchReq = 0.

[in] cchReq

Menentukan ukuran buffer pchText dalam karakter.

[out] pcch

Menerima jumlah karakter yang disalin ke dalam buffer pchText .

[in] fUpdateAnchor

Jika TRUE, paStart akan diposisikan ulang hanya melewati karakter terakhir yang disalin ke pchText.

Nilai kembali

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai	Deskripsi
S_OK	Metode berhasil diselesaikan.
E_FAIL	Metode tidak dapat memperoleh penunjuk antarmuka yang valid ke paStart dan/atau paEnd.
TF_E_INVALIDPOS	Jangkar paStart atau paEnd berada di luar teks dokumen.
TS_E_NOLOCK	Pemanggil tidak memiliki kunci baca-saja pada dokumen.

Keterangan

Pemanggil yang menggunakan metode ini harus memiliki kunci baca-saja pada dokumen dengan memanggil metode ITextStoreAnchor::RequestLock . Tanpa kunci baca-saja, metode gagal dan mengembalikan TF_E_NOLOCK.

Aplikasi dapat memotong nilai pengembalian metode karena alasan internal.

Untuk memindai teks dengan cepat dengan beberapa panggilan GetText , pemanggil akan menggunakan fUpdateAnchor = TRUE.

Jumlah karakter aktual yang disalin bisa kurang dari cchReq jika jumlah karakter antara paStart dan paEnd kurang dari cchReq.

Perilaku GetText tidak dipengaruhi oleh batas wilayah apa pun yang dicakup oleh teks yang dikembalikan.

Persyaratan


Klien minimum yang didukung	Windows 2000 Professional [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows 2000 Server [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	textstor.h
DLL	Msctf.dll
Redistribusi	TSF 1.0 di Windows 2000 Professional

Lihat juga

ITextStoreAnchor

ITextStoreAnchor::RequestLock

Nilai Pengembalian Manajer

TS_RUNINFO