ITextStoreAnchor::Metode AdviseSink (textstor.h)

  • Artikel

Metode ITextStoreAnchor::AdviseSink menginstal sink saran baru dari antarmuka ITextStoreAnchorSink atau memodifikasi sink saran yang ada.

Sintaks

HRESULT AdviseSink(
  [in] REFIID   riid,
  [in] IUnknown *punk,
  [in] DWORD    dwMask
);

Parameter

[in] riid

Menentukan antarmuka sink. Satu-satunya nilai yang didukung adalah IID_ITextStoreAnchorSink.

[in] punk

Arahkan ke antarmuka sink untuk disarankan. Tidak boleh NULL.

[in] dwMask

Menentukan peristiwa yang memberi tahu sink saran. Untuk informasi selengkapnya tentang kemungkinan nilai parameter, lihat TS_AS_* Konstanta.

Nilai kembali

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai Deskripsi
S_OK
 Metode berhasil.
E_FAIL
 Riid antarmuka sink yang ditentukan tidak dapat diperoleh.
E_INVALIDARG
 Antarmuka sink yang ditentukan tidak didukung.
E_UNEXPECTED
 Objek sink yang ditentukan tidak dapat diperoleh.

Keterangan

Panggilan berikutnya dengan antarmuka yang sama, yang diwakili oleh parameter punk , ditangani sebagai permintaan untuk memperbarui parameter dwMask . Server tidak boleh memanggil metode AddRef pada sink sebagai respons terhadap permintaan tersebut.

Server hanya mempertahankan satu titik koneksi. Upaya untuk menyarankan objek sink kedua gagal sampai objek sink asli dihapus. Aplikasi harus menggunakan metode ITextStoreAnchor::UnadviseSink untuk membatalkan pendaftaran objek sink saat pemberitahuan tidak diperlukan.

Persyaratan

Persyaratan Nilai
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::UnadviseSink

TS_AS_* Konstanta