Files
wownero-cpp/docs/doxygen/structmonero_1_1monero__wallet__config.html

215 lines
16 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Monero C++ Library: monero::monero_wallet_config Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Monero C++ Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemonero.html">monero</a></li><li class="navelem"><a class="el" href="structmonero_1_1monero__wallet__config.html">monero_wallet_config</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structmonero_1_1monero__wallet__config-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">monero::monero_wallet_config Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="monero__wallet__model_8h_source.html">monero_wallet_model.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for monero::monero_wallet_config:</div>
<div class="dyncontent">
<div class="center">
<img src="structmonero_1_1monero__wallet__config.png" usemap="#monero::monero_5Fwallet_5Fconfig_map" alt=""/>
<map id="monero::monero_5Fwallet_5Fconfig_map" name="monero::monero_5Fwallet_5Fconfig_map">
<area href="structmonero_1_1serializable__struct.html" alt="monero::serializable_struct" shape="rect" coords="0,0,183,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad6446ee1be8116f03504ef7efe9b3424" id="r_ad6446ee1be8116f03504ef7efe9b3424"><td class="memItemLeft" align="right" valign="top"><a id="ad6446ee1be8116f03504ef7efe9b3424" name="ad6446ee1be8116f03504ef7efe9b3424"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>monero_wallet_config</b> (const <a class="el" href="structmonero_1_1monero__wallet__config.html">monero_wallet_config</a> &amp;config)</td></tr>
<tr class="separator:ad6446ee1be8116f03504ef7efe9b3424"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb2f54719c718f58686f529dfae28487" id="r_afb2f54719c718f58686f529dfae28487"><td class="memItemLeft" align="right" valign="top"><a id="afb2f54719c718f58686f529dfae28487" name="afb2f54719c718f58686f529dfae28487"></a>
<a class="el" href="structmonero_1_1monero__wallet__config.html">monero_wallet_config</a>&#160;</td><td class="memItemRight" valign="bottom"><b>copy</b> () const</td></tr>
<tr class="separator:afb2f54719c718f58686f529dfae28487"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c42adc920b5116e839fe0f4d7f8211d" id="r_a1c42adc920b5116e839fe0f4d7f8211d"><td class="memItemLeft" align="right" valign="top">rapidjson::Value&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1c42adc920b5116e839fe0f4d7f8211d">to_rapidjson_val</a> (rapidjson::Document::AllocatorType &amp;allocator) const</td></tr>
<tr class="separator:a1c42adc920b5116e839fe0f4d7f8211d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structmonero_1_1serializable__struct"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_structmonero_1_1serializable__struct')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structmonero_1_1serializable__struct.html">monero::serializable_struct</a></td></tr>
<tr class="memitem:a723e44b22962d02d3f78bc7c2043dc1e inherit pub_methods_structmonero_1_1serializable__struct" id="r_a723e44b22962d02d3f78bc7c2043dc1e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmonero_1_1serializable__struct.html#a723e44b22962d02d3f78bc7c2043dc1e">serialize</a> () const</td></tr>
<tr class="separator:a723e44b22962d02d3f78bc7c2043dc1e inherit pub_methods_structmonero_1_1serializable__struct"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:af596ede2894e8d13675505a5334c1072" id="r_af596ede2894e8d13675505a5334c1072"><td class="memItemLeft" align="right" valign="top"><a id="af596ede2894e8d13675505a5334c1072" name="af596ede2894e8d13675505a5334c1072"></a>
static std::shared_ptr&lt; <a class="el" href="structmonero_1_1monero__wallet__config.html">monero_wallet_config</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>deserialize</b> (const std::string &amp;config_json)</td></tr>
<tr class="separator:af596ede2894e8d13675505a5334c1072"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a76c8d0f36aeb5cdb736adbcb22c8c46d" id="r_a76c8d0f36aeb5cdb736adbcb22c8c46d"><td class="memItemLeft" align="right" valign="top"><a id="a76c8d0f36aeb5cdb736adbcb22c8c46d" name="a76c8d0f36aeb5cdb736adbcb22c8c46d"></a>
boost::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_path</b></td></tr>
<tr class="separator:a76c8d0f36aeb5cdb736adbcb22c8c46d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ecd58a56147ded6ba829e9d9ecdc488" id="r_a3ecd58a56147ded6ba829e9d9ecdc488"><td class="memItemLeft" align="right" valign="top"><a id="a3ecd58a56147ded6ba829e9d9ecdc488" name="a3ecd58a56147ded6ba829e9d9ecdc488"></a>
boost::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_password</b></td></tr>
<tr class="separator:a3ecd58a56147ded6ba829e9d9ecdc488"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a600e6dbf68ea8ca0a59fb3f745cb0ea2" id="r_a600e6dbf68ea8ca0a59fb3f745cb0ea2"><td class="memItemLeft" align="right" valign="top"><a id="a600e6dbf68ea8ca0a59fb3f745cb0ea2" name="a600e6dbf68ea8ca0a59fb3f745cb0ea2"></a>
boost::optional&lt; <a class="el" href="namespacemonero.html#ac9023a1d513e2526775d1e061bb5beed">monero_network_type</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_network_type</b></td></tr>
<tr class="separator:a600e6dbf68ea8ca0a59fb3f745cb0ea2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f1c8f090a5895ce060fe6aacafc0b77" id="r_a2f1c8f090a5895ce060fe6aacafc0b77"><td class="memItemLeft" align="right" valign="top"><a id="a2f1c8f090a5895ce060fe6aacafc0b77" name="a2f1c8f090a5895ce060fe6aacafc0b77"></a>
boost::optional&lt; <a class="el" href="structmonero_1_1monero__rpc__connection.html">monero_rpc_connection</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_server</b></td></tr>
<tr class="separator:a2f1c8f090a5895ce060fe6aacafc0b77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8dfd62daa984e7c526627ceb17bd8eae" id="r_a8dfd62daa984e7c526627ceb17bd8eae"><td class="memItemLeft" align="right" valign="top"><a id="a8dfd62daa984e7c526627ceb17bd8eae" name="a8dfd62daa984e7c526627ceb17bd8eae"></a>
boost::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_seed</b></td></tr>
<tr class="separator:a8dfd62daa984e7c526627ceb17bd8eae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30c6b4d2e58b4e3bda8725beab2cfc9e" id="r_a30c6b4d2e58b4e3bda8725beab2cfc9e"><td class="memItemLeft" align="right" valign="top"><a id="a30c6b4d2e58b4e3bda8725beab2cfc9e" name="a30c6b4d2e58b4e3bda8725beab2cfc9e"></a>
boost::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_seed_offset</b></td></tr>
<tr class="separator:a30c6b4d2e58b4e3bda8725beab2cfc9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a107ac9e073728f2ea3641360c1de6609" id="r_a107ac9e073728f2ea3641360c1de6609"><td class="memItemLeft" align="right" valign="top"><a id="a107ac9e073728f2ea3641360c1de6609" name="a107ac9e073728f2ea3641360c1de6609"></a>
boost::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_primary_address</b></td></tr>
<tr class="separator:a107ac9e073728f2ea3641360c1de6609"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8204e2f1e5da8397531000c4a209837" id="r_af8204e2f1e5da8397531000c4a209837"><td class="memItemLeft" align="right" valign="top"><a id="af8204e2f1e5da8397531000c4a209837" name="af8204e2f1e5da8397531000c4a209837"></a>
boost::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_private_view_key</b></td></tr>
<tr class="separator:af8204e2f1e5da8397531000c4a209837"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07e9c605599fd624dd5d8d32ec708f07" id="r_a07e9c605599fd624dd5d8d32ec708f07"><td class="memItemLeft" align="right" valign="top"><a id="a07e9c605599fd624dd5d8d32ec708f07" name="a07e9c605599fd624dd5d8d32ec708f07"></a>
boost::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_private_spend_key</b></td></tr>
<tr class="separator:a07e9c605599fd624dd5d8d32ec708f07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2b649dc5ad5db0883c3cbfa29caa097" id="r_ac2b649dc5ad5db0883c3cbfa29caa097"><td class="memItemLeft" align="right" valign="top"><a id="ac2b649dc5ad5db0883c3cbfa29caa097" name="ac2b649dc5ad5db0883c3cbfa29caa097"></a>
boost::optional&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_restore_height</b></td></tr>
<tr class="separator:ac2b649dc5ad5db0883c3cbfa29caa097"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c5d82d06d85dcf42abe090c2e1bd042" id="r_a3c5d82d06d85dcf42abe090c2e1bd042"><td class="memItemLeft" align="right" valign="top"><a id="a3c5d82d06d85dcf42abe090c2e1bd042" name="a3c5d82d06d85dcf42abe090c2e1bd042"></a>
boost::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_language</b></td></tr>
<tr class="separator:a3c5d82d06d85dcf42abe090c2e1bd042"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f7db4a6bfe7515d1d41744196106cdb" id="r_a8f7db4a6bfe7515d1d41744196106cdb"><td class="memItemLeft" align="right" valign="top"><a id="a8f7db4a6bfe7515d1d41744196106cdb" name="a8f7db4a6bfe7515d1d41744196106cdb"></a>
boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_save_current</b></td></tr>
<tr class="separator:a8f7db4a6bfe7515d1d41744196106cdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a982135fd422ffaae886cfe5f0daed68c" id="r_a982135fd422ffaae886cfe5f0daed68c"><td class="memItemLeft" align="right" valign="top"><a id="a982135fd422ffaae886cfe5f0daed68c" name="a982135fd422ffaae886cfe5f0daed68c"></a>
boost::optional&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_account_lookahead</b></td></tr>
<tr class="separator:a982135fd422ffaae886cfe5f0daed68c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a2430f4a274de4baa6a2588cb3ac17a" id="r_a3a2430f4a274de4baa6a2588cb3ac17a"><td class="memItemLeft" align="right" valign="top"><a id="a3a2430f4a274de4baa6a2588cb3ac17a" name="a3a2430f4a274de4baa6a2588cb3ac17a"></a>
boost::optional&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_subaddress_lookahead</b></td></tr>
<tr class="separator:a3a2430f4a274de4baa6a2588cb3ac17a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeadba24a8dc37b5cf5634905fb03d2f2" id="r_aeadba24a8dc37b5cf5634905fb03d2f2"><td class="memItemLeft" align="right" valign="top"><a id="aeadba24a8dc37b5cf5634905fb03d2f2" name="aeadba24a8dc37b5cf5634905fb03d2f2"></a>
boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_is_multisig</b></td></tr>
<tr class="separator:aeadba24a8dc37b5cf5634905fb03d2f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Configures a wallet to create. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1c42adc920b5116e839fe0f4d7f8211d" name="a1c42adc920b5116e839fe0f4d7f8211d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c42adc920b5116e839fe0f4d7f8211d">&#9670;&#160;</a></span>to_rapidjson_val()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">rapidjson::Value monero::monero_wallet_config::to_rapidjson_val </td>
<td>(</td>
<td class="paramtype">rapidjson::Document::AllocatorType &amp;</td> <td class="paramname"><span class="paramname"><em>allocator</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts the struct to a rapidjson Value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">allocator</td><td>is the rapidjson document allocator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the struct as a rapidjson Value </dd></dl>
<p>Implements <a class="el" href="structmonero_1_1serializable__struct.html#a3c53ab95b12f02db20cf20cd6d69ad4b">monero::serializable_struct</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>wallet/<a class="el" href="monero__wallet__model_8h_source.html">monero_wallet_model.h</a></li>
<li>wallet/<b>monero_wallet_model.cpp</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>