ITfRange::InsertEmbedded method (msctf.h)

Artikel
03/08/2023

Metode ITfRange::InsertEmbedded menyisipkan objek di lokasi jangkar awal rentang teks.

Sintaks

HRESULT InsertEmbedded(
  [in] TfEditCookie ec,
  [in] DWORD        dwFlags,
  [in] IDataObject  *pDataObject
);

Parameter

[in] ec

Edit cookie yang diperoleh dari ITfDocumentMgr::CreateContext atau ITfEditSession::D oEditSession.

[in] dwFlags

Bidang bit yang menentukan bagaimana penyisipan harus terjadi. Jika TF_IE_CORRECTION diatur, operasinya adalah koreksi, sehingga layanan teks lainnya dapat mempertahankan data yang terkait dengan teks asli.

[in] pDataObject

Penunjuk ke objek transfer data yang akan disisipkan.

Mengembalikan nilai

Metode ini dapat mengembalikan salah satu nilai ini.

Nilai	Deskripsi
S_OK	Metode berhasil.
E_NOTIMPL	Aplikasi penerapan tidak mengekspos objek yang disematkan dalam alirannya.
TF_E_COMPOSITION_REJECTED	Pemilik konteks menolak komposisi default.
TF_E_FORMAT	Pemilik konteks tidak dapat menangani tipe objek yang ditentukan.
TF_E_NOLOCK	Nilai parameter ec adalah cookie yang tidak valid, atau pemanggil tidak memiliki kunci baca-saja.
TF_E_RANGE_NOT_COVERED	Penelepon sudah memiliki komposisi aktif, tetapi rentang diposisikan di atas teks yang tidak dicakup oleh komposisi.
TF_E_READONLY	Dokumen atau lokasi rentang tidak dapat diubah.

Keterangan

Gunakan metode ini untuk menyisipkan objek ke dalam aliran teks, karena karakter tempat penampung objek TF_CHAR_EMBEDDED tidak dapat diteruskan ke ITfRange::SetText. Metode ini dimodelkan setelah API clipboard OLE, dengan aplikasi menggunakan pDataObject seperti yang akan ditampilkan IDataObject dari OleGetClipboard.

Ketika rentang mencakup beberapa wilayah, metode harus dipanggil pada setiap wilayah secara terpisah. Jika tidak, metode mungkin gagal.

Secara default, layanan teks memulai dan mengakhiri komposisi sementara yang mencakup rentang, untuk memastikan bahwa pemilik konteks secara konsisten mengenali komposisi melalui teks yang diedit. Jika pemilik komposisi menolak komposisi default, maka metode mengembalikan TF_E_COMPOSITION_REJECTED. Komposisi default hanya dibuat jika pemanggil belum memulainya. Jika penelepon memiliki komposisi aktif, panggilan gagal.

Untuk menentukan terlebih dahulu apakah pemilik konteks mendukung penyisipan objek tertentu, gunakan ITfQueryEmbedded::QueryInsertEmbedded.

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