Freigeben über


Platform::Collections::Map-Klasse

Stellt eine Zuordnungdar, die eine Auflistung von Schlüssel-Wert-Paaren ist. Implementiert Windows::Foundation::Collections::IObservableMap zur Unterstützung bei der XAML-Datenbindung.

Syntax

template <
   typename K,
   typename V,
   typename C = std::less<K>>
ref class Map sealed;

Parameter

K
Der Typ des Schlüssels im Schlüssel-Wert-Paar.

B
Der Typ des Werts im Schlüssel-Wert-Paar.

C
Ein Typ, der ein Funktionsobjekt bereitstellt, das zwei Elementwerte als Sortierschlüssel vergleichen kann, um deren relative Reihenfolge in der Map zu bestimmen. Standardmäßig std ::less<K>.

__is_valid_winrt_type() Eine vom Compiler generierte Funktion, die den Typ von K und V überprüft und eine Anzeigefehlermeldung bereitstellt, wenn der Typ nicht in der Karte gespeichert werden kann.

Hinweise

Folgende Typen sind zulässig:

  • integers

  • Schnittstellenklasse^

  • Öffentliche Referenzklasse^

  • value struct

  • Öffentliche Enumerationsklasse

Die Zuordnung ist im Grunde genommen ein Wrapper für std::map. Es handelt sich um eine konkrete C++-Implementierung der Windows::Foundation::Collections::IMap<Windows::Foundation::Collections::IKeyValuePair<K,V>>- und IObservableMap-Typen, die über öffentliche Windows-Runtime Schnittstellen übergeben werden. Wenn Sie versuchen, einen Platform::Collections::Map -Typ in einem öffentlichen Rückgabewert oder Parameter zu verwenden, wird der Compilerfehler C3986 ausgelöst. Sie können den Fehler beheben, indem Sie den Typ des Parameters oder den Rückgabewert in Windows::Foundation::Collections::IMap<K,V> ändern.

Weitere Informationen finden Sie unter Auflistungen (C++/CX).

Member

Öffentliche Konstruktoren

Name Beschreibung
Map::Map Initialisiert eine neue Instanz der Map-Klasse.

Öffentliche Methoden

Name Beschreibung
Karte::Löschen Entfernt alle Schlüssel-Wert-Paare aus dem derzeitigen Map-Objekt.
Karte::First Gibt einen Iterator zurück, der das erste Element in der Zuordnung angibt.
Map::GetView Gibt eine schreibgeschützte Ansicht der aktuellen Zuordnung zurück; das heißt, eine Platform::Collections::MapView Class.
Map::HasKey Ermittelt, ob die aktuelle Map den angegebenen Schlüssel enthält.
Map::Insert Fügt das angegebene Schlüssel-Wert-Paar dem aktuellen Map-Objekt hinzu.
Map::Lookup Ruft das Element am angegebenen Schlüssel im aktuellen Map-Objekt ab.
Map::Remove Löscht das angegebene Schlüssel-Wert-Paar vom aktuellen Map-Objekt.
Karte::Größe Gibt die Anzahl von Elementen im aktuellen Map-Objekt zurück.

Ereignisse

Name Beschreibung
Map::MapChanged-Ereignis Tritt auf, wenn sich die Map ändert.

Vererbungshierarchie

Map

Anforderungen

Header: collection.h

Namespace: Platform::Collections

Map::Clear-Methode

Entfernt alle Schlüssel-Wert-Paare aus dem derzeitigen Map-Objekt.

Syntax

virtual void Clear();

Map::First-Methode

Gibt einen Iterator zurück, der das erste Element in der Zuordnung angibt, oder nullptr, wenn die Zuordnung leer ist.

Syntax

virtual Windows::Foundation::Collections::IIterator<
Windows::Foundation::Collections::IKeyValuePair<K, V>^>^ First();

Rückgabewert

Ein Iterator, der das erste Element in der Zuordnung angibt.

Hinweise

Eine bequeme Möglichkeit zum Speichern des iterators, der von First() zurückgegeben wird, ist das Zuweisen des Rückgabewerts zu einer Variablen, die mit dem auto Schlüsselwort "Typabzug" deklariert wird. Beispiel: auto x = myMap->First();.

Map::GetView-Methode

Gibt eine schreibgeschützte Ansicht der aktuellen Karte zurück. d. h. eine Platform::Collections::MapView-Klasse, die die Windows::Foundation::Collections::IMapView<K,V-Schnittstelle> implementiert.

Syntax

Windows::Foundation::Collections::IMapView<K, V>^ GetView();

Rückgabewert

Ein MapView-Objekt.

Map::HasKey-Methode

Ermittelt, ob die aktuelle Map den angegebenen Schlüssel enthält.

Syntax

bool HasKey(K key);

Parameter

key
Der zum Suchen des Map-Elements verwendete Schlüssel. Der Schlüsseltyp ist Typename K.

Rückgabewert

truewenn der Schlüssel gefunden wird; andernfalls . false

Map::Insert-Methode

Fügt das angegebene Schlüssel-Wert-Paar dem aktuellen Map-Objekt hinzu.

Syntax

virtual bool Insert(K key, V value);

Parameter

key
Der Schlüsselteil des Schlüssel-Wert-Paars. Der Schlüsseltyp ist Typename K.

value
Der Wertteil des Schlüssel-Wert-Paars. Der Typ des Werts ist typename V.

Rückgabewert

truewenn der Schlüssel eines vorhandenen Elements im aktuellen Kartenschlüssel übereinstimmt und der Wertteil dieses Elements auf "Wert" festgelegt ist. falsewenn kein vorhandenes Element im aktuellen Kartenschlüssel übereinstimmt und die Schlüssel- und Wertparameter in ein Schlüssel-Wert-Paar umgewandelt und dann zur aktuellen Karte hinzugefügt werden.

Map::Lookup-Methode

Ruft den Wert des Typs V ab, der mit dem angegebenen Schlüssel des Typs K verknüpft ist, sofern der Schlüssel vorhanden ist.

Syntax

V Lookup(K key);

Parameter

key
Der zum Suchen eines in der Zuordnung vorhandenen Elements verwendete Schlüssel. Der Schlüsseltyp ist Typename K.

Rückgabewert

Der Wert, der mit dem Schlüssel gekoppelt ist. Der Typ des Rückgabewerts ist typename V.

Hinweise

Wenn der Schlüssel nicht vorhanden ist, wird eine Platform::OutOfBoundsException ausgelöst.

Map::Map-Konstruktor

Initialisiert eine neue Instanz der Map-Klasse.

Syntax

explicit Map(const C& comp = C());
explicit Map(const StdMap& m);
explicit Map(StdMap&& m ;
template <typename InIt>
Map(
   InItfirst,
   InItlast,
   const C& comp = C());

Parameter

Anfang
Der Typname der aktuellen Map.

comp
Ein Typ, der ein Funktionsobjekt bereitstellt, das zwei Elementwerte als Sortierschlüssel vergleichen kann, um deren relative Reihenfolge in der Map zu bestimmen.

m
Ein Verweis oder Einwert auf einen map Class Wert, der zum Initialisieren der aktuellen Karte verwendet wird.

first
Der Eingabeiterator des ersten Elements in einem Bereich von Elementen, die verwendet werden, um die aktuelle Map zu initialisieren.

last
Der Eingabeiterator des ersten Elements nach einem Bereich von Elementen, die verwendet werden, um die aktuelle Map zu initialisieren.

Map::MapChanged-Ereignis

Wird ausgelöst, wenn ein Element in eine Zuordnung eingefügt bzw. aus der Zuordnung entfernt wird.

Syntax

event Windows::Foundation::Collections::MapChangedEventHandler<K,V>^ MapChanged;

Eigenschaftswert/Rückgabewert

A MapChangedEventHandler<K,V> that contains information about the object that raised the event, and the kind of change that occurred. Siehe auch IMapChangedEventArgs<K> und CollectionChange-Aufzählung.

Entsprechung in .NET Framework

Windows-Runtime Apps, die C# oder Visual Basic-Projekt IMap< verwendenK,V> als IDictionary<K,V>.

Map::Remove-Methode

Löscht das angegebene Schlüssel-Wert-Paar vom aktuellen Map-Objekt.

Syntax

virtual void Remove(K key);

Parameter

key
Der Schlüsselteil des Schlüssel-Wert-Paars. Der Schlüsseltyp ist Typename K.

Map::Size-Methode

Gibt die Anzahl der Windows::Foundation::Collections::IKeyValuePair<K,V-Elemente> in der Karte zurück.

Syntax

virtual property unsigned int Size;

Rückgabewert

Die Anzahl von Elementen in der Zuordnung.

Siehe auch

Sammlungen (C++-CX)
Plattformnamespace
Erstellen von Komponenten für Windows-Runtime in C++