boost::urls::params_encoded_ref::erase

Erase params

Synopsis

Declared in <include/boost/url/params_encoded_ref.hpp>

std::size_t
erase(
    pct_string_view key,
    ignore_case_param ic = = {}) noexcept;

Description

All iterators are invalidated.

this->count( key, ic ) == 0

Linear in `this‐>url().encoded_query().size()`.

Exceptions thrown on invalid input.

Exceptions

Name Thrown on

Name	Thrown on
`key`	contains an invalid percent&hyphen;encoding&period;

`key`

contains an invalid percent&hyphen;encoding&period;

Return Value

The number of params removed from the container.

Parameters

Name	Description
key	The key to match&period; By default, a case&hyphen;sensitive comparison is used&period;
ic	An optional parameter&period; If the value xref:boost/urls/ignore_case.adoc[ignore&lowbar;case] is passed here, the comparison is case&hyphen;insensitive&period;

Name

Description

key

The key to match&period; By default, a case&hyphen;sensitive comparison is used&period;

An optional parameter&period; If the value xref:boost/urls/ignore_case.adoc[ignore&lowbar;case] is passed here, the comparison is case&hyphen;insensitive&period;

Created with MrDocs