json/api/basic_json/get_binary.md

nlohmann::basic_json::get_binary

binary_t& get_binary();

const binary_t& get_binary() const;

Returns a reference to the stored binary value.

Return value

Reference to binary value.

Exception safety

Strong exception safety: if an exception occurs, the original value stays intact.

Exceptions

Throws type_error.302 if the value is not binary

Complexity

Constant.

Examples

??? example

The following code shows how to query a binary value.
 
```cpp
--8<-- "examples/get_binary.cpp"
```

Output:

```json
--8<-- "examples/get_binary.output"
```

See also

• get get a value (explicit conversion)
• get_ref get a reference to the stored value

Version history

• Added in version 3.8.0.