option_stream_scan_t Class Reference
[Run-Time Options]

Inherits w_base_t.

Inheritance diagram for option_stream_scan_t:

[legend]Collaboration diagram for option_stream_scan_t:

[legend]List of all members.

---

Detailed Description

Enables scanning of options group. See Run-Time Options.

Given an instream, scan for options in a given option_troup_t on that stream. This is used by option_file_scan_t.

Definition at line 378 of file option.h.

Public Member Functions
	option_stream_scan_t (istream &is, option_group_t *option_group)
	~option_stream_scan_t ()
void	setLabel (const char *label)
w_rc_t	scan (bool over_ride, ostream &err_stream, bool exact=false, bool mismatch_ok=false)
	Scan all options, report errors to err_stream.

---

Member Function Documentation

w_rc_t option_stream_scan_t::scan	(	bool	over_ride,
		ostream &	err_stream,
		bool	exact = false,
		bool	mismatch_ok = false
	)

Scan all options, report errors to err_stream.

Parameters:

[in]	over_ride	If false, new values of options will be ignored. If true, assignments to already-set options will be made.
[out]	err_stream	Send error message here if non-NULL.
[in]	exact	If true, misspellings or abbreviations of option names in the instream will result in errors.
[in]	mismatch_ok	If true, bad option names will be ignored and will not cause failure of the entire scan.

Definition at line 815 of file option.cpp.

References DBG, w_rc_t::err_num(), w_rc_t::is_error(), option_group_t::lookup_by_class(), RC, RCOK, and option_t::set_value().

Referenced by option_file_scan_t::scan().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• src/common/option.h
• src/common/option.cpp

---