Freigeben über


ITfReadOnlyProperty::EnumRanges-Methode (msctf.h)

Ruft eine Enumeration von Bereichen ab, die eindeutige Werte der Eigenschaft innerhalb des angegebenen Bereichs enthalten.

Syntax

HRESULT EnumRanges(
  [in]  TfEditCookie  ec,
  [out] IEnumTfRanges **ppEnum,
  [in]  ITfRange      *pTargetRange
);

Parameter

[in] ec

Enthält ein Bearbeitungscookies, das den Bearbeitungskontext identifiziert. Dies wird von ITfDocumentMgr::CreateContext oder ITfEditSession::D oEditSession abgerufen.

[out] ppEnum

Zeiger auf einen IEnumTfRanges-Schnittstellenzeiger , der das Enumeratorobjekt empfängt. Der Aufrufer muss dieses Objekt freigeben, wenn es nicht mehr benötigt wird.

[in] pTargetRange

Zeiger auf eine ITfRange-Schnittstelle , die den Bereich angibt, der nach eindeutigen Eigenschaftswerten gesucht werden soll. Dieser Parameter ist optional und kann NULL sein. Weitere Informationen finden Sie im Abschnitt mit Hinweisen.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Wert BESCHREIBUNG
S_OK
Die Methode war erfolgreich.
E_INVALIDARG
Mindestens ein Parameter ist ungültig.
E_OUTOFMEMORY
Ein Speicherbelegungsfehler ist aufgetreten.
E_FAIL
Es ist ein unbekannter Fehler aufgetreten.
Hinweis Wenn eine Anwendung ITextStoreACP::FindNextAttrTransition nicht implementiert, schlägt ITfReadOnlyProperty::EnumRanges mit E_FAIL fehl.
 
TF_E_NOLOCK
Der von ec identifizierte Bearbeitungskontext verfügt nicht über eine Schreib- oder Lese-/Schreibsperre.

Hinweise

Hinweis: Wenn eine Anwendung ITextStoreACP::FindNextAttrTransition nicht implementiert, schlägt ITfReadOnlyProperty::EnumRanges mit E_FAIL fehl.

Der von dieser Methode abgerufene Enumerator enthält einen Bereich für jeden eindeutigen Wert, einschließlich leerer Werte, der angegebenen Eigenschaft. Beispielsweise kann eine hypothetische Farbeigenschaft auf den folgenden markierten Text angewendet werden:


COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text

Wenn ITfReadOnlyProperty::EnumRanges aufgerufen wird, wobei pTargetRange auf diesen Bereich festgelegt ist, enthält der Enumerator fünf Bereiche.

Bereichsindex Color-Eigenschaftswert Bereichstext
0 <empty> "this "
1 R „is“ (ist)
2 <empty> " einige "
3 G "farbig"
4 <empty> "text"
 

Wenn pTargetRangeNULL ist, beginnt und endet der Enumerator mit dem ersten und letzten Bereich, der einen nicht leeren Eigenschaftswert im Kontext enthält. Die Angabe von NULL für pTargetRange im obigen Beispiel würde zu einem Enumerator mit drei Bereichen führen.

Bereichsindex Color-Eigenschaftswert Text innerhalb des Bereichs
0 R „is“ (ist)
1 <empty> " einige "
2 G "farbig"
 

Die aufgezählten Bereiche beginnen und enden mit den Start- und Endankern von pTargetRange, auch wenn sich ein Anker in der Mitte einer Eigenschaft befindet.

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

IEnumTfRanges

ITfDocumentMgr::CreateContext

ITfEditSession::D oEditSession

ITfRange

ITfReadOnlyProperty