Platform::Collections::Map, classe
Représente une cartequi est une collection de paires clé-valeur. Implémente Windows ::Foundation ::Collections ::IObservableMap pour faciliter la liaison de données XAML.
Syntaxe
template <
typename K,
typename V,
typename C = std::less<K>>
ref class Map sealed;
Paramètres
K
Type de la clé dans la paire clé-valeur.
V
Type de la valeur dans la paire clé-valeur.
C
Type qui fournit un objet de fonction qui peut comparer deux valeurs d'élément comme des clés de tri pour déterminer leur ordre relatif dans le Map. Par défaut, std ::less<K>.
__is_valid_winrt_type() Une fonction générée par le compilateur qui valide le type de K et V et fournit un message d’erreur convivial si le type ne peut pas être stocké dans la carte.
Notes
Les types autorisés sont :
entiers
interface, classe^
Classe ref publique ^
value struct
classe d'énumération publique
Map est essentiellement un wrapper pour std::map. Il s’agit d’une implémentation concrète C++ des types Windows ::Foundation ::Collections ::IMap<Windows ::Foundation ::Collections ::IKeyValuePair<K, V>> et IObservableMap passés entre les interfaces Windows Runtime publiques. Si vous tentez d'utiliser un type Platform::Collections::Map dans une valeur de retour ou un paramètre public, l'erreur de compilateur C3986 est générée. Vous pouvez corriger l’erreur en modifiant le type du paramètre ou la valeur renvoyée par Windows ::Foundation ::Collections ::IMap<K,V>.
Pour plus d’informations, consultez Collections.
Membres
Constructeurs publics
| Nom | Description |
|---|---|
| Map ::Map | Initialise une nouvelle instance de la classe Map. |
Méthodes publiques
| Nom | Description |
|---|---|
| Map ::Clear | Supprime toutes les paires clé-valeur de l'objet Map actuel. |
| Map ::First | Retourne un itérateur qui spécifie le premier élément de la carte. |
| Map ::GetView | Retourne une vue en lecture seule du Map actif ; autrement dit, Platform::Collections::MapView Class. |
| Map ::HasKey | Détermine si le Map actuel contient la clé spécifiée. |
| Map ::Insert | Ajoute une paire clé-valeur spécifiée à l'objet Map actuel. |
| Map ::Lookup | Récupère l'élément à la clé spécifiée dans l'objet Map actuel. |
| Map ::Remove | Supprime la paire clé-valeur spécifiée de l'objet Map actuel. |
| Map ::Size | Retourne le nombre d'éléments dans l'objet Map actuel. |
Événements
| Nom | Description |
|---|---|
| Événement Map ::MapChanged | Se produit lorsque l'objet Map est modifié. |
Hiérarchie d'héritage
Map
Spécifications
En-tête : collection.h
Espace de noms : Platform::Collections
Map::Clear, méthode
Supprime toutes les paires clé-valeur de l'objet Map actuel.
Syntaxe
virtual void Clear();
Map::First, méthode
Retourne un itérateur qui spécifie le premier élément de la carte ou nullptr si la carte est vide.
Syntaxe
virtual Windows::Foundation::Collections::IIterator<
Windows::Foundation::Collections::IKeyValuePair<K, V>^>^ First();
Valeur de retour
Itérateur qui spécifie le premier élément de la carte.
Notes
Un moyen pratique de contenir l’itérateur retourné par First() consiste à affecter la valeur de retour à une variable déclarée avec le mot clé de déduction de auto type. Par exemple : auto x = myMap->First();.
Map::GetView, méthode
Renvoie une vue en lecture seule de la carte active ; autrement dit, une classe Platform ::Collections ::MapView, qui implémente l’interface Windows ::Foundation ::Collections ::IMapView<K,V>.
Syntaxe
Windows::Foundation::Collections::IMapView<K, V>^ GetView();
Valeur de retour
Objet MapView.
Map::HasKey, méthode
Détermine si le Map actuel contient la clé spécifiée.
Syntaxe
bool HasKey(K key);
Paramètres
key
Clé utilisée pour rechercher l’élément Map. Le type de clé est K de typename.
Valeur de retour
true si la clé est trouvée ; sinon, false.
Map::Insert, méthode
Ajoute une paire clé-valeur spécifiée à l'objet Map actuel.
Syntaxe
virtual bool Insert(K key, V value);
Paramètres
key
Partie de clé de la paire clé-valeur. Le type de clé est K de typename.
value
Partie de valeur de la paire clé-valeur. Le type de valeur est typename V.
Valeur de retour
true si la clé d’un élément existant dans le mappage actuel correspond à la clé et que la partie valeur de cet élément est définie sur la valeur. false si aucun élément existant dans la carte actuelle ne correspond à la clé et que les paramètres clé et valeur sont créés en paire clé-valeur, puis ajoutés à la carte actuelle.
Map::Lookup, méthode
Récupère la valeur de type V associée à la clé spécifiée de type K si la clé existe.
Syntaxe
V Lookup(K key);
Paramètres
key
Clé utilisée pour trouver un élément dans le Map. Le type de clé est K de typename.
Valeur de retour
Valeur associée à la clé. Le type de la valeur de retour est typename V.
Notes
Si la clé n’existe pas, une exception Platform ::OutOfBoundsException est levée.
Map::Map, constructeur
Initialise une nouvelle instance de la classe Map.
Syntaxe
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());
Paramètres
Init
Nom de type de l'objet Map actuel.
comp
Type qui fournit un objet de fonction qui peut comparer deux valeurs d'élément comme des clés de tri pour déterminer leur ordre relatif dans le Map.
m
Référence ou rvalue à une map Class valeur utilisée pour initialiser le mappage actuel.
first
Itérateur d'entrée du premier élément d'une plage d'éléments utilisée pour initialiser le Map actuel.
last
Itérateur d'entrée du premier élément qui suit une plage d'éléments utilisée pour initialiser le Map actuel.
Map::MapChanged, événement
Se déclenche lorsqu'un élément est inséré ou supprimé dans le mappage.
Syntaxe
event Windows::Foundation::Collections::MapChangedEventHandler<K,V>^ MapChanged;
Valeur de propriété/valeur de retour
MapChangedEventHandler<K,V> qui contient des informations sur l’objet qui a déclenché l’événement et le type de modification qui s’est produit. Voir également IMapChangedEventArgs<K> et CollectionChange, énumération.
Équivalent .NET Framework
Applications Windows Runtime qui utilisent C# ou un projet Visual Basic IMap<K,V> en tant que IDictionary<K,V>.
Map::Remove, méthode
Supprime la paire clé-valeur spécifiée de l'objet Map actuel.
Syntaxe
virtual void Remove(K key);
Paramètres
key
Partie de clé de la paire clé-valeur. Le type de clé est K de typename.
Map::Size, méthode
Renvoie le nombre d’éléments Windows ::Foundation ::Collections ::IKeyValuePair<K,V> dans la carte.
Syntaxe
virtual property unsigned int Size;
Valeur de retour
Nombre d'éléments du Map.
Voir aussi
Collections (C++/CX)
Espace de noms de plateforme
Création de composants Windows Runtime en C++