IAnchor::Metode shift (textstor.h)

Artikel
03/02/2024

Metode IAnchor::Shift menggeser jangkar ke depan atau mundur dalam aliran teks.

Sintaks

HRESULT Shift(
  [in]  DWORD   dwFlags,
  [in]  LONG    cchReq,
  [out] LONG    *pcch,
  [in]  IAnchor *paHaltAnchor
);

Parameter

[in] dwFlags

Bidang bit yang digunakan untuk menghindari penempatan jangkar.

Nilai	Makna
TS_SHIFT_COUNT_ONLY	Jangkar tidak digeser. Jika bendera tidak diatur (dwFlags = 0), jangkar akan digeser seperti yang ditentukan oleh pengaturan parameter lainnya.

[in] cchReq

Jumlah karakter untuk memindahkan jangkar dalam aliran teks.

[out] pcch

Jumlah karakter aktual yang dipindahkan dalam aliran teks. Metode ini akan mengatur pcch ke nol jika gagal.

[in] paHaltAnchor

Referensi ke jangkar yang memblokir pergeseran. Atur ke NULL untuk menghindari pemblokiran shift.

Nilai kembali

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai	Deskripsi
S_OK	Metode berhasil.
E_FAIL	Pergeseran gagal.
E_INVALIDARG	Nilai parameter input tidak valid.
E_NOTIMPL	Nilai parameter dwFlags tidak diimplementasikan dalam metode ini.

Keterangan

parameter cchReq dan pcch bisa negatif, yang berarti pergeseran mundur dalam aliran teks, atau positif, yang berarti pergeseran maju. Jumlah karakter aktual yang digeser dapat kurang dari cchReq jika awal atau akhir dokumen ditemukan, batas wilayah ditemui, atau jika paHaltAnchor menerima jangkar yang memblokir pergeseran.

Jika paHaltAnchor menerima jangkar yang memblokir pergeseran, aplikasi akan memotong pergeseran pada posisi yang ditempati oleh paHaltAnchor. Jika paHaltAnchor tidak berada dalam rentang teks yang dicakup oleh pergeseran, paHaltAnchor tidak memiliki relevansi dengan pergeseran dan diabaikan.

Misalnya, jika jangkar yang dirujuk oleh paHaltAnchor terletak 8 karakter di depan jangkar di aliran, dan klien memanggil Shift (0, 10, pcch, paHaltAnchor), maka saat keluar jangkar hanya akan memindahkan 8 karakter. Jika jangkar yang dirujuk oleh paHaltAnchor sama dengan jangkar saat ini untuk dipindahkan, maka Shift akan berhasil kembali tanpa memindahkan jangkar sama sekali. Dalam hal ini pcch akan menjadi 0.

Pergeseran jangkar selalu diblokir oleh batas wilayah, seolah-olah awal atau akhir dokumen ditemukan. Ini akan ditunjukkan saat keluar oleh pcch shift aktual yang lebih kecil dalam nilai absolut daripada shift cchReq yang diminta. Dalam hal ini, klien dapat menggunakan IAnchor::ShiftRegion untuk mengalihkan jangkar ke wilayah yang berdampingan.

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	textstor.h
DLL	Msctf.dll
Redistribusi	TSF 1.0 di Windows 2000 Professional

Lihat juga

IAnchor

IAnchor::ShiftRegion

Bagikan melalui