boost::urls::url_base::encoded_params :: Boost Libraries Documentation

# boost::urls::url_base::encoded_params

Return the query as a container of parameters

## Synopsis

Declared in `<boost/url/url_base.hpp>`

    params_encoded_view
    encoded_params() const 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.

## Example

    params_encoded_view pv = url_view( "/sql?id=42&name=jane%2Ddoe&page+size=20" ).encoded_params();

## Complexity

Constant.

## Exception Safety

Throws nothing.

## BNF

    query           = *( pchar / "/" / "?" )
    query-param     = key [ "=" value ]
    query-params    = [ query-param ] *( "&" query-param )

## Specification

- 3.4. Query (rfc3986)

- Query string (Wikipedia)

## Return Value

A bidirectional view of key/value pairs.

## See Also

`encoded_query`, `has_query`, `params`, `query`.

Created with MrDocs