[#ArgsManager-ReadConfigStream]
= xref:ArgsManager.adoc[ArgsManager]::ReadConfigStream
:relfileprefix: ../
:mrdocs:

Read and interpret configuration settings from a stream.

== Synopsis

Declared in `<common/args.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard, requires_capability(0x7f2e381ab9e8)]]
bool
ReadConfigStream(
    std::istream& stream,
    std::string const& filepath,
    std::string& error,
    bool ignore_invalid_keys = false);
----

== Return Value

true if the stream was parsed successfully.

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Parameters

[cols="1,4"]
|===
| Name| Description
| *stream*
| The input stream to read config lines from.
| *filepath*
| Path used for error messages and section tracking.
| *error*
| Populated with a message if parsing fails.
| *ignore_invalid_keys*
| Skip unknown keys instead of failing.
|===


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