[#boost-urls-params_encoded_ref-erase-00]
= xref:boost/urls/params_encoded_ref/erase-00.adoc[boost::urls::params_encoded_ref::erase]
:relfileprefix: ../../../
:mrdocs:

Erase params

== Synopsis

Declared in `<https://www.github.com/boostorg/url/blob/develop/include/boost/url/params_encoded_ref.hpp#L666[boost/url/params_encoded_ref.hpp]>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::size_t
erase(
    xref:boost/urls/pct_string_view.adoc[pct_string_view] key,
    xref:boost/urls/ignore_case_param.adoc[ignore_case_param] ic = {}) noexcept;
----

== Description

All iterators are invalidated.

== Postconditions
[,cpp]
----
this->count( key, ic ) == 0
----
== Complexity
Linear in `this‐>url().encoded_query().size()`.

== Exception Safety
Exceptions thrown on invalid input.

== Exceptions

[cols=2]
|===
| Name
| Thrown on
| `system_error`
| `key` contains an invalid percent‐encoding.
|===

== Return Value

The number of params removed from the container.

== Parameters

[cols=2]
|===
| Name
| Description
| *key*
| The key to match. By default, a case‐sensitive comparison is used.
| *ic*
| An optional parameter. If the value xref:boost/urls/ignore_case.adoc[`ignore_case`] is passed here, the comparison is case‐insensitive.
|===


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