boost::urls::url_base::params :: Boost Libraries Documentation

# boost::urls::url_base::params

Return the query as a container of parameters

## Synopsis

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

    params_ref
    params(encoding_opts opt) 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. Any percent‐escapes in strings returned when iterating the view are decoded first. The container is modifiable; changes to the container are reflected in the underlying URL.

## Example

    encoding_opts opt;
    opt.space_as_plus = true;
    params_ref pv = url( "/sql?id=42&name=jane+doe&page+size=20" ).params(opt);

## 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 range of references to the parameters.

## Parameters

Name | Description
opt | The options for decoding. If this parameter is omitted, the `space_as_plus` is used.

## See Also

`encoded_params`, `remove_query`, `set_encoded_query`, `set_query`.

Created with MrDocs