Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext
url_base::set_encoded_query

Set the query.

Synopsis
url_base&
set_encoded_query(
    pct_string_view s);
Description

This sets the query to the string, which may contain percent-escapes and can be empty. An empty query is distinct from having no query. Escapes in the string are preserved, and reserved characters in the string are percent-escaped in the result.

Example
assert( [link url.ref.boost__urls__url_base.url `url`]( "http://example.com" ).[link url.ref.boost__urls__url_base.set_encoded_query `set_encoded_query`]( "id=42" ).[link url.ref.boost__urls__url_base.encoded_query `encoded_query`]() == "id=42" );
Postconditions
this->[link url.ref.boost__urls__url_base.has_query `has_query`]() == true && this->[link url.ref.boost__urls__url_base.query `query`]() == decode_view( s );
Exception Safety

Strong guarantee. Calls to allocate may throw. Exceptions thrown on invalid input.

Parameters

Name

Description

s

The string to set.

Exceptions

Type

Thrown On

system_error

s contains an invalid percent-encoding.

BNF
[link url.ref.boost__urls__url_base.query `query`]           = *( pchar / "/" / "?" )

[link url.ref.boost__urls__url_base.query `query`]-param     = key [ "=" value ]
[link url.ref.boost__urls__url_base.query `query`]-[link url.ref.boost__urls__url_base.params `params`]    = [ [link url.ref.boost__urls__url_base.query `query`]-param ] *( "&" [link url.ref.boost__urls__url_base.query `query`]-param )
Specification
See Also

encoded_params, params, remove_query, set_query.


PrevUpHomeNext