Function params_ref::unset

Remove the value on an element

Synopsis

Declared in header <boost/url/params_ref.hpp>

params_base::iterator
unset(params_base::iterator pos) noexcept;

Description

This function removes the value of an element at the specified position. After the call returns, has_value for the element is false.

All iterators that are equal to pos or come after are invalidated.

Example

url u( "?first=John&last=Doe" );

u.params().unset( u.params().begin() );

assert( u.encoded_query() == "first&last=Doe" );

Complexity

Linear in this->url().encoded_query().size().

Exception Safety

Throws nothing.

Return Value

An iterator to the element.

Parameters

Name Description

pos

An iterator to the element.