[#boost-urls-url_base-encoded_params-06]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::xref:boost/urls/url_base.adoc[url_base]::encoded_params
:relfileprefix: ../../../
:mrdocs:

Return the query as a container of parameters

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:boost/urls/params_encoded_ref.adoc[params_encoded_ref]
encoded_params() noexcept;
----

== Description

This function returns a bidirectional view of key/value pairs over the query. The returned view references the same underlying character buffer; ownership is not transferred. Strings returned when iterating the range may contain percent escapes. The container is modifiable; changes to the container are reflected in the underlying URL.

== Example
[,cpp]
----
params_encoded_ref pv = url( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_params();
----
== Complexity
Constant.

== Exception Safety
Throws nothing.

== BNF
[,cpp]
----
query           = *( pchar / "/" / "?" )

query-param     = key [ "=" value ]
query-params    = [ query-param ] *( "&" query-param )
----
== Specification
* https://datatracker.ietf.org/doc/html/rfc3986#section-3.4[]
* https://en.wikipedia.org/wiki/Query_string[]

== Return Value

`*this`

== See Also

xref:boost/urls/url_base/params-0c1.adoc[`params`], xref:boost/urls/url_base/remove_query.adoc[`remove_query`], xref:boost/urls/url_base/set_encoded_query.adoc[`set_encoded_query`], xref:boost/urls/url_base/set_query.adoc[`set_query`].


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