ITfContext::RequestEditSession-Methode (msctf.h)

  • Artikel

Ruft Zugriff auf den Dokumenttext und die Eigenschaften ab.

Syntax

HRESULT RequestEditSession(
  [in]  TfClientId     tid,
  [in]  ITfEditSession *pes,
  [in]  DWORD          dwFlags,
  [out] HRESULT        *phrSession
);

Parameter

[in] tid

Enthält einen TfClientId-Wert , der den Client identifiziert, mit dem die Bearbeitungssitzung hergestellt werden soll.

[in] pes

Zeiger auf eine ITfEditSession-Schnittstelle , die aufgerufen wird, um die Bearbeitungssitzung auszuführen.

[in] dwFlags

Enthält einen oder mehrere der folgenden Werte.

Wert Bedeutung
TF_ES_ASYNCDONTCARE
 Die Bearbeitungssitzung kann synchron oder asynchron im Ermessen des TSF-Managers erfolgen. Der Manager versucht, eine synchrone Bearbeitungssitzung zu planen, um die Leistung zu verbessern. Dieser Wert kann nicht mit den TF_ES_ASYNC- oder TF_ES_SYNC-Werten kombiniert werden.
TF_ES_SYNC
 Die Bearbeitungssitzung muss synchron sein, andernfalls schlägt die Anforderung fehl (mit TF_E_SYNCHRONOUS). Dieses Flag sollte nur in dokumentierten Situationen (z. B. bei der Tastatureingabebehandlung) verwendet werden, in denen erwartet werden kann, dass es erfolgreich ist. Andernfalls schlägt der Aufruf wahrscheinlich fehl. Dieser Wert kann nicht mit den TF_ES_ASYNCDONTCARE- oder TF_ES_ASYNC-Werten kombiniert werden.
TF_ES_READ
 Fordert schreibgeschützten Zugriff auf den Kontext an.
TF_ES_READWRITE
 Fordert Lese-/Schreibzugriff auf den Kontext an.
TF_ES_ASYNC
 Die Bearbeitungssitzung muss asynchron sein, andernfalls schlägt die Anforderung fehl. Dieser Wert kann nicht mit den TF_ES_ASYNCDONTCARE- oder TF_ES_SYNC-Werten kombiniert werden.

[out] phrSession

Adresse eines HRESULT-Werts , der das Ergebnis der Sitzungsbearbeitungsanforderung empfängt. Der empfangene Wert hängt vom Typ der angeforderten Bearbeitungssitzung ab.

  • Wenn eine asynchrone Bearbeitungssitzung angefordert wird und eingerichtet werden kann, empfängt TF_S_ASYNC.
  • Wenn eine synchrone Bearbeitungssitzung angefordert wird und nicht eingerichtet werden kann, empfängt TF_E_SYNCHRONOUS.
  • Wenn das TF_ES_READWRITE-Flag angegeben ist und das Dokument schreibgeschützt ist, empfängt TS_E_READONLY.
  • Wenn eine synchrone Bearbeitungssitzung eingerichtet wird, empfängt den Rückgabewert von ITfEditSession::D oEditSession.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Wert BESCHREIBUNG
S_OK
 Die Methode war erfolgreich. phrSession enthält weitere Ergebnisdaten für die -Methode.
TF_E_LOCKED
 Der Aufrufer befindet sich im Kontext eines anderen Textdiensts, der bereits eine Sperre enthält.
TF_E_DISCONNECTED
 Der Kontext befindet sich nicht in einem Dokumentstapel.
E_INVALIDARG
 Mindestens ein Parameter ist ungültig.
E_OUTOFMEMORY
 Ein Speicherbelegungsfehler ist aufgetreten.

Hinweise

Ausstehende asynchrone Bearbeitungssitzungen werden in der empfangenen Reihenfolge verarbeitet. Synchrone Bearbeitungssitzungen werden vor ausstehenden asynchronen Bearbeitungssitzungen verarbeitet.

Ein Textdienst kann eine Bearbeitungssitzung im Kontext einer vorhandenen Bearbeitungssitzung anfordern, sofern innerhalb einer schreibgeschützten Sitzung keine Schreibzugriffssitzung angefordert wird. Aufrufe dieser Methode im Kontext einer Bearbeitungssitzung, die von einem anderen Textdienst eingerichtet wurde, schlagen mit TF_E_LOCKED fehl.

Eine synchrone Lese-/Schreibanforderung schlägt fehl, wenn sie beim Verarbeiten einer der folgenden Benachrichtigungen erfolgt.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows 2000 Professional [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile msctf.h
DLL Msctf.dll
Verteilbare Komponente TSF 1.0 unter Windows 2000 Professional

Weitere Informationen

ITfContext-Schnittstelle, ITfEditSession-Schnittstelle, ITfStatusSink::OnStatusChange, ITfTextEditSink::OnEndEdit, ITfTextLayoutSink::OnLayoutChange