[#bsl-map-0a7-erase-0b]
= xref:bsl.adoc[bsl]::xref:bsl/map-0a7.adoc[map]::erase
:relfileprefix: ../../
:mrdocs:

Erase the element whose key is equivalent to `key`.

== Synopsis

Declared in `<bslstl_map.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bsl/map-0a7/size_type.adoc[map<KEY, VALUE, COMPARATOR, ALLOCATOR>::size_type]
erase(xref:bsl/map-0a7/key_type.adoc[key_type] const& key);
----

== Description

Remove from this map the `value_type` object whose key is equivalent the specified `key`, if such an entry exists, and return 1; otherwise, if there is no `value_type` object having an equivalent key, return 0 with no other effect. This method invalidates only iterators and references to the removed element and previously saved values of the `end()` iterator.

== Return Value

1 if an element was erased, otherwise 0

== Parameters

[cols="1,4"]
|===
| Name| Description
| *key*
| key whose matching element is erased
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#