json/doc/mkdocs/docs/api/basic_json/get_binary.md
Niels Lohmann 29cd970b94
Consolidate documentation (#3071)
* 🔥 consolidate documentation
* ♻️ overwork std specializations
* 🚚 move images files to mkdocs
* ♻️ fix URLs
* 🔧 tweak MkDocs configuration
* 🔧 add namespaces
* 📝 document deprecations
* 📝 document documentation generation
* 🚸 improve search
* 🚸 add examples
* 🚧 start adding documentation for macros
* 📝 add note for https://github.com/nlohmann/json/issues/874#issuecomment-1001699139
* 📝 overwork example handling
* 📝 fix Markdown tables
2021-12-29 13:41:01 +01:00

745 B

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"
```

Version history

  • Added in version 3.8.0.