Classe Platform::Collections::MapPlatform::Collections::Map Class

Representa um mapa, que é uma coleção de pares chave-valor.Represents a map, which is a collection of key-value pairs. Implementa Windows:: Foundation:: Collections:: IObservableMap para ajudar com a vinculação de dadosXAML.Implements Windows::Foundation::Collections::IObservableMap to help with XAML data binding.

SintaxeSyntax

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

parâmetrosParameters

CK
O tipo de chave em pares chave-valor.The type of the key in the key-value pair.

LV
O tipo de valor em pares chave-valor.The type of the value in the key-value pair.

CC
Um tipo que fornece um objeto de função que pode comparar dois valores de elemento como chaves de classificação para determinar sua ordem relativa no Map.A type that provides a function object that can compare two element values as sort keys to determine their relative order in the Map. Por padrão, std:: less <K> .By default, std::less<K>.

__is_valid_winrt_type () Uma função gerada pelo compilador que valida o tipo de K e V e fornece uma mensagem de erro amigável se o tipo não puder ser armazenado no mapa.__is_valid_winrt_type() A compiler-generated function that validates the type of K and V and provides a friendly error message if the type cannot be stored in the Map.

ComentáriosRemarks

Os tipos permitidos são:Allowed types are:

  • integersintegers

  • classe de interface ^interface class^

  • classe ref pública^public ref class^

  • estrutura de valorvalue struct

  • classe de enum públicapublic enum class

O mapa é basicamente um wrapper para std::map.Map is basically a wrapper for std::map. É uma implementação concreta do C++ dos tipos Windows:: Foundation:: Collections:: IMap <Windows::Foundation::Collections::IKeyValuePair<K,V> > e IObservableMap que são transmitidos entre as interfaces de Windows Runtime pública.It is a C++ concrete implementation of the Windows::Foundation::Collections::IMap<Windows::Foundation::Collections::IKeyValuePair<K,V>> and IObservableMap types that are passed across public Windows Runtime interfaces. Se você tentar usar um tipo Platform::Collections::Map em um parâmetro ou valor de retorno público, o erro do compilador C3986 será gerado.If you try to use a Platform::Collections::Map type in a public return value or parameter, compiler error C3986 is raised. Você pode corrigir o erro alterando o tipo do parâmetro ou valor de retorno para Windows:: Foundation:: Collections:: IMap <K,V> .You can fix the error by changing the type of the parameter or return value to Windows::Foundation::Collections::IMap<K,V>.

Para obter mais informações, consulte coleções.For more information, see Collections.

MembrosMembers

Construtores públicosPublic Constructors

NomeName DescriçãoDescription
Mapa:: mapMap::Map Inicializa uma nova instância da classe Map.Initializes a new instance of the Map class.

Métodos públicosPublic Methods

NomeName DescriçãoDescription
Mapa:: limparMap::Clear Remove todos os pares chave-valor do objeto Map atual.Removes all key-value pairs from the current Map object.
Mapa:: primeiroMap::First Retorna um iterador que especifica o primeiro elemento no mapa.Returns an iterator that specifies the first element in the map.
MAP:: GetViewMap::GetView Retorna uma exibição somente leitura do Mapa atual; isto é, um Platform::Collections::MapView Class.Returns a read-only view of the current Map; that is, a Platform::Collections::MapView Class.
MAP:: HasKeyMap::HasKey Determina se o Map atual contém a chave especificada.Determines whether the current Map contains the specified key.
Mapa:: inserirMap::Insert Adiciona os pares chave-valor especificados ao objeto Map atual.Adds the specified key-value pair to the current Map object.
Mapa:: LookupMap::Lookup Recupera o elemento na chave especificada no objeto Map atual.Retrieves the element at the specified key in the current Map object.
Map::RemoveMap::Remove Exclui os pares chave-valor especificados do objeto Map atual.Deletes the specified key-value pair from the current Map object.
Mapa:: tamanhoMap::Size Retorna o número de elementos no objeto Map atual.Returns the number of elements in the current Map object.

EventosEvents

NomeName DescriçãoDescription
Evento map:: MapChangedMap::MapChanged event Ocorre quando o Map é alterado.Occurs when the Map changes.

Hierarquia de herançaInheritance Hierarchy

Map

RequisitosRequirements

Cabeçalho: collection.hHeader: collection.h

Namespace: Platform::CollectionsNamespace: Platform::Collections

Método map:: ClearMap::Clear Method

Remove todos os pares chave-valor do objeto Map atual.Removes all key-value pairs from the current Map object.

SintaxeSyntax

virtual void Clear();

MAP:: primeiro métodoMap::First Method

Retorna um iterador que especifica o primeiro elemento no mapa ou nullptr se o mapa está vazio.Returns an iterator that specifies the first element in the map, or nullptr if the map is empty.

SintaxeSyntax

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

Valor retornadoReturn Value

Um iterador que especifica o primeiro elemento no mapa.An iterator that specifies the first element in the map.

ComentáriosRemarks

Uma maneira conveniente de manter o iterador retornado pelo primeiro () é atribuir o valor de retorno a uma variável que é declarada com a auto palavra-chave de dedução de tipo.A convenient way to hold the iterator returned by First() is to assign the return value to a variable that is declared with the auto type deduction keyword. Por exemplo, auto x = myMap->First();.For example, auto x = myMap->First();.

Método map:: GetViewMap::GetView Method

Retorna uma exibição somente leitura do mapa atual; ou seja, uma classe Platform:: Collections:: MapView, que implementa a interface Windows:: Foundation:: Collections:: <K,V> IMapView .Returns a read-only view of the current Map; that is, a Platform::Collections::MapView Class, which implements the Windows::Foundation::Collections::IMapView<K,V> interface.

SintaxeSyntax

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

Valor retornadoReturn Value

Um objeto MapView.A MapView object.

Método map:: HasKeyMap::HasKey Method

Determina se o Map atual contém a chave especificada.Determines whether the current Map contains the specified key.

SintaxeSyntax

bool HasKey(K key);

parâmetrosParameters

chavekey
A chave usada para localizar o elemento Map.The key used to locate the Map element. O tipo de chave é TypeName K.The type of key is typename K.

Valor RetornadoReturn Value

true se a chave for encontrada; caso contrário, false .true if the key is found; otherwise, false.

Método map:: InsertMap::Insert Method

Adiciona os pares chave-valor especificados ao objeto Map atual.Adds the specified key-value pair to the current Map object.

SintaxeSyntax

virtual bool Insert(K key, V value);

parâmetrosParameters

chavekey
A porção de chave do par chave-valor.The key portion of the key-value pair. O tipo de chave é TypeName K.The type of key is typename K.

valuevalue
A porção de valor do par chave-valor.The value portion of the key-value pair. O tipo de valor é TypeName V.The type of value is typename V.

Valor RetornadoReturn Value

true se a chave de um elemento existente no mapa atual corresponder à chave e a parte de valor desse elemento for definida como valor.true if the key of an existing element in the current Map matches key and the value portion of that element is set to value. false Se nenhum elemento existente no mapa atual corresponder à chave , os parâmetros de chave e valor serão feitos em um par chave-valor e, em seguida, adicionados ao mapa atual.false if no existing element in the current Map matches key and the key and value parameters are made into a key-value pair and then added to the current Map.

Método map:: LookupMap::Lookup Method

Recupera o valor do tipo V que está associado à chave especificada do tipo K, se a chave existir.Retrieves the value of type V that is associated with the specified key of type K, if the key exists.

SintaxeSyntax

V Lookup(K key);

parâmetrosParameters

chavekey
A chave usada para localizar um elemento em Map.The key used to locate an element in the Map. O tipo de chave é TypeName K.The type of key is typename K.

Valor RetornadoReturn Value

O valor que é emparelhado com a chave.The value that is paired with the key. O tipo do valor de retorno é TypeName V.The type of the return value is typename V.

ComentáriosRemarks

Se a chave não existir, uma plataforma:: OutOfBoundsException será lançada.If the key does not exist, then a Platform::OutOfBoundsException is thrown.

Construtor map:: mapMap::Map Constructor

Inicializa uma nova instância da classe Map.Initializes a new instance of the Map class.

SintaxeSyntax

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());

parâmetrosParameters

IniciarInIt
O typename do Map atual.The typename of the current Map.

compcomp
Um tipo que fornece um objeto de função que pode comparar dois valores de elemento como chaves de classificação para determinar sua ordem relativa no Map.A type that provides a function object that can compare two element values as sort keys to determine their relative order in the Map.

dm
Uma referência ou um rvalue para um map Class que é usado para inicializar o mapa atual.A reference or rvalue to a map Class that is used to initialize the current Map.

firstfirst
O iterador de entrada do primeiro elemento em um intervalo de elementos usados para inicializar o Map atual.The input iterator of the first element in a range of elements used to initialize the current Map.

lastlast
O iterador de entrada do primeiro elemento após um intervalo de elementos usados para inicializar o Map atual.The input iterator of the first element after a range of elements used to initialize the current Map.

Evento MAP:: MapChangedMap::MapChanged Event

Gerado quando um item é inserido no mapa ou removido dele.Raised when an item is inserted into or removed from the map.

SintaxeSyntax

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

Valor da propriedade/Valor do retornoProperty Value/Return Value

Um MapChangedEventHandler <K,V> que contém informações sobre o objeto que disparou o evento e o tipo de alteração ocorrida.A MapChangedEventHandler<K,V> that contains information about the object that raised the event, and the kind of change that occurred. Consulte também enumeração <K> IMapChangedEventArgs e CollectionChange.See also IMapChangedEventArgs<K> and CollectionChange Enumeration.

Equivalente ao .NET Framework.NET Framework Equivalent

Windows Runtime aplicativos que usam C# ou Visual Basic projeto IMap <K,V> como IDictionary <K,V> .Windows Runtime apps that use C# or Visual Basic project IMap<K,V> as IDictionary<K,V>.

Método map:: RemoveMap::Remove Method

Exclui os pares chave-valor especificados do objeto Map atual.Deletes the specified key-value pair from the current Map object.

SintaxeSyntax

virtual void Remove(K key);

parâmetrosParameters

chavekey
A porção de chave do par chave-valor.The key portion of the key-value pair. O tipo de chave é TypeName K.The type of key is typename K.

Método map:: SizeMap::Size Method

Retorna o número de elementos Windows:: Foundation:: Collections:: <K,V> IKeyValuePair no mapa.Returns the number of Windows::Foundation::Collections::IKeyValuePair<K,V> elements in the Map.

SintaxeSyntax

virtual property unsigned int Size;

Valor retornadoReturn Value

O número de elementos em Map.The number of elements in the Map.

Confira tambémSee also

Coleções (C++/CX)Collections (C++/CX)
Namespace da plataformaPlatform Namespace
Criando componentes do Windows Runtime no C++Creating Windows Runtime Components in C++