boost-react-native-bundle

Version:

Boost library as in https://sourceforge.net/projects/boost/files/boost/1.57.0/

111 lines (108 loc) • 12.3 kB

HTML

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template basic_option</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.option_hpp" title="Header <boost/program_options/option.hpp>"> <link rel="prev" href="invalid_bool_value.html" title="Class invalid_bool_value"> <link rel="next" href="option_description.html" title="Class option_description"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> <td align="center"><a href="../../../../index.html">Home</a></td> <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> <td align="center"><a href="../../../../more/index.htm">More</a></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="invalid_bool_value.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.option_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="option_description.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.basic_option"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Class template basic_option</h2> boost::program_options::basic_option </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.option_hpp" title="Header <boost/program_options/option.hpp>">boost/program_options/option.hpp</a>> template<typename charT> class <a class="link" href="basic_option.html" title="Class template basic_option">basic_option</a> { public: // <a class="link" href="basic_option.html#boost.program_options.basic_optionconstruct-copy-destruct">construct/copy/destruct</a> <a class="link" href="basic_option.html#idp46603312-bb">basic_option</a>(); <a class="link" href="basic_option.html#idp46603600-bb">basic_option</a>(const std::string &, const std::vector< std::string > &); // <a class="link" href="basic_option.html#boost.program_options.basic_optionpublic-data-members">public data members</a> std::string <a class="link" href="basic_option.html#boost.program_options.basic_option.string_key">string_key</a>; int <a class="link" href="basic_option.html#boost.program_options.basic_option.position_key">position_key</a>; std::vector< std::basic_string< charT > > <a class="link" href="basic_option.html#boost.program_options.basic_option.value">value</a>; std::vector< std::basic_string< charT > > <a class="link" href="basic_option.html#boost.program_options.basic_option.original_tokens">original_tokens</a>; bool <a class="link" href="basic_option.html#boost.program_options.basic_option.unregistered">unregistered</a>; bool <a class="link" href="basic_option.html#boost.program_options.basic_option.case_insensitive">case_insensitive</a>; };</pre></div> <div class="refsect1"> <a name="idp344927056"></a><h2>Description</h2> Option found in input source. Contains a key and a value. The key, in turn, can be a string (name of an option), or an integer (position in input source) <ndash></ndash> in case no name is specified. The latter is only possible for command line. The template parameter specifies the type of char used for storing the option's value. <div class="refsect2"> <a name="idp344928336"></a><h3> <a name="boost.program_options.basic_optionconstruct-copy-destruct"></a><code class="computeroutput">basic_option</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"><pre class="literallayout"><a name="idp46603312-bb"></a>basic_option();</pre></li> <li class="listitem"><pre class="literallayout"><a name="idp46603600-bb"></a>basic_option(const std::string & xstring_key, const std::vector< std::string > & xvalue);</pre></li> </ol></div> </div> <div class="refsect2"> <a name="idp344947760"></a><h3> <a name="boost.program_options.basic_optionpublic-data-members"></a><code class="computeroutput">basic_option</code> public public data members</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">std::string <a name="boost.program_options.basic_option.string_key"></a>string_key;</pre> String key of this option. Intentionally independent of the template parameter. </li> <li class="listitem"> <pre class="literallayout">int <a name="boost.program_options.basic_option.position_key"></a>position_key;</pre> Position key of this option. All options without an explicit name are sequentially numbered starting from 0. If an option has explicit name, 'position_key' is equal to -1. It is possible that both position_key and string_key is specified, in case name is implicitly added. </li> <li class="listitem"> <pre class="literallayout">std::vector< std::basic_string< charT > > <a name="boost.program_options.basic_option.value"></a>value;</pre> Option's value </li> <li class="listitem"> <pre class="literallayout">std::vector< std::basic_string< charT > > <a name="boost.program_options.basic_option.original_tokens"></a>original_tokens;</pre> The original unchanged tokens this option was created from. </li> <li class="listitem"> <pre class="literallayout">bool <a name="boost.program_options.basic_option.unregistered"></a>unregistered;</pre> True if option was not recognized. In that case, 'string_key' and 'value' are results of purely syntactic parsing of source. The original tokens can be recovered from the "original_tokens" member. </li> <li class="listitem"> <pre class="literallayout">bool <a name="boost.program_options.basic_option.case_insensitive"></a>case_insensitive;</pre> True if string_key has to be handled case insensitive. </li> </ol></div> </div> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> <td align="left"></td> <td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir PrusDistributed under the Boost Software License, Version 1.0. (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) </div></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="invalid_bool_value.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.option_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="option_description.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html>