| <!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"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.15"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>AMCL: bls256_BLS48.h File 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> |
| <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 style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">AMCL |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(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"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_df7310d1a865926cc859bcfb1880083f.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#define-members">Macros</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">bls256_BLS48.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>BLS Header file. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include "pair256_BLS48.h"</code><br /> |
| </div> |
| <p><a href="bls256__BLS48_8h_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> |
| Macros</h2></td></tr> |
| <tr class="memitem:a7bfb8fb2ea55a10466d24594b0a6ff5f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bls256__BLS48_8h.html#a7bfb8fb2ea55a10466d24594b0a6ff5f">BGS_BLS48</a>   <a class="el" href="config__big__560__58_8h.html#a13505faed4d03b9091b1e8968c008429">MODBYTES_560_58</a></td></tr> |
| <tr class="separator:a7bfb8fb2ea55a10466d24594b0a6ff5f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac0f0f4d79c00bb2c74e9e69cff2dab3e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bls256__BLS48_8h.html#ac0f0f4d79c00bb2c74e9e69cff2dab3e">BFS_BLS48</a>   <a class="el" href="config__big__560__58_8h.html#a13505faed4d03b9091b1e8968c008429">MODBYTES_560_58</a></td></tr> |
| <tr class="separator:ac0f0f4d79c00bb2c74e9e69cff2dab3e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0954a33675757ad87dde21d92a448805"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bls256__BLS48_8h.html#a0954a33675757ad87dde21d92a448805">BLS_OK</a>   0</td></tr> |
| <tr class="separator:a0954a33675757ad87dde21d92a448805"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad7ad1154a1fc1e13c0c9020ba3b2efa8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bls256__BLS48_8h.html#ad7ad1154a1fc1e13c0c9020ba3b2efa8">BLS_FAIL</a>   41</td></tr> |
| <tr class="separator:ad7ad1154a1fc1e13c0c9020ba3b2efa8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acf6e7c8f3dac9ed955df538eeddfe65a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bls256__BLS48_8h.html#acf6e7c8f3dac9ed955df538eeddfe65a">BLS_INVALID_G1</a>   42</td></tr> |
| <tr class="separator:acf6e7c8f3dac9ed955df538eeddfe65a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0e1f50f8bd36bc147cf2c39e917047aa"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bls256__BLS48_8h.html#a0e1f50f8bd36bc147cf2c39e917047aa">BLS_INVALID_G2</a>   43</td></tr> |
| <tr class="separator:a0e1f50f8bd36bc147cf2c39e917047aa"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a7a8481f3854741dee7788aa873fc03d4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="bls256__BLS48_8h.html#a7a8481f3854741dee7788aa873fc03d4">BLS_BLS48_KEY_PAIR_GENERATE</a> (<a class="el" href="structcsprng.html">csprng</a> *RNG, <a class="el" href="structoctet.html">octet</a> *S, <a class="el" href="structoctet.html">octet</a> *W)</td></tr> |
| <tr class="memdesc:a7a8481f3854741dee7788aa873fc03d4"><td class="mdescLeft"> </td><td class="mdescRight">Generate Key Pair. <a href="#a7a8481f3854741dee7788aa873fc03d4">More...</a><br /></td></tr> |
| <tr class="separator:a7a8481f3854741dee7788aa873fc03d4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aca4a3373e24203541075a1242d469b48"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="bls256__BLS48_8h.html#aca4a3373e24203541075a1242d469b48">BLS_BLS48_SIGN</a> (<a class="el" href="structoctet.html">octet</a> *SIG, char *m, <a class="el" href="structoctet.html">octet</a> *S)</td></tr> |
| <tr class="memdesc:aca4a3373e24203541075a1242d469b48"><td class="mdescLeft"> </td><td class="mdescRight">Calculate a signature. <a href="#aca4a3373e24203541075a1242d469b48">More...</a><br /></td></tr> |
| <tr class="separator:aca4a3373e24203541075a1242d469b48"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1a63c26de2f02ed7529f3df2621d515e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="bls256__BLS48_8h.html#a1a63c26de2f02ed7529f3df2621d515e">BLS_BLS48_VERIFY</a> (<a class="el" href="structoctet.html">octet</a> *SIG, char *m, <a class="el" href="structoctet.html">octet</a> *W)</td></tr> |
| <tr class="memdesc:a1a63c26de2f02ed7529f3df2621d515e"><td class="mdescLeft"> </td><td class="mdescRight">Verify a signature. <a href="#a1a63c26de2f02ed7529f3df2621d515e">More...</a><br /></td></tr> |
| <tr class="separator:a1a63c26de2f02ed7529f3df2621d515e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab6c79daa940bb9d3228bdfa152fe148e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="bls256__BLS48_8h.html#ab6c79daa940bb9d3228bdfa152fe148e">BLS_BLS48_ADD_G1</a> (<a class="el" href="structoctet.html">octet</a> *R1, <a class="el" href="structoctet.html">octet</a> *R2, <a class="el" href="structoctet.html">octet</a> *R)</td></tr> |
| <tr class="memdesc:ab6c79daa940bb9d3228bdfa152fe148e"><td class="mdescLeft"> </td><td class="mdescRight">Add two members from the group G1. <a href="#ab6c79daa940bb9d3228bdfa152fe148e">More...</a><br /></td></tr> |
| <tr class="separator:ab6c79daa940bb9d3228bdfa152fe148e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acb44039e4daf6fe37c1284602e91a5f4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="bls256__BLS48_8h.html#acb44039e4daf6fe37c1284602e91a5f4">BLS_BLS48_ADD_G2</a> (<a class="el" href="structoctet.html">octet</a> *W1, <a class="el" href="structoctet.html">octet</a> *W2, <a class="el" href="structoctet.html">octet</a> *W)</td></tr> |
| <tr class="memdesc:acb44039e4daf6fe37c1284602e91a5f4"><td class="mdescLeft"> </td><td class="mdescRight">Add two members from the group G2. <a href="#acb44039e4daf6fe37c1284602e91a5f4">More...</a><br /></td></tr> |
| <tr class="separator:acb44039e4daf6fe37c1284602e91a5f4"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><dl class="section author"><dt>Author</dt><dd>Mike Scott </dd></dl> |
| <dl class="section date"><dt>Date</dt><dd>28th Novemebr 2018 Allows some user configuration defines structures declares functions </dd></dl> |
| </div><h2 class="groupheader">Macro Definition Documentation</h2> |
| <a id="ac0f0f4d79c00bb2c74e9e69cff2dab3e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac0f0f4d79c00bb2c74e9e69cff2dab3e">◆ </a></span>BFS_BLS48</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define BFS_BLS48   <a class="el" href="config__big__560__58_8h.html#a13505faed4d03b9091b1e8968c008429">MODBYTES_560_58</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>BLS Field Size </p> |
| |
| </div> |
| </div> |
| <a id="a7bfb8fb2ea55a10466d24594b0a6ff5f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7bfb8fb2ea55a10466d24594b0a6ff5f">◆ </a></span>BGS_BLS48</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define BGS_BLS48   <a class="el" href="config__big__560__58_8h.html#a13505faed4d03b9091b1e8968c008429">MODBYTES_560_58</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>BLS Group Size </p> |
| |
| </div> |
| </div> |
| <a id="ad7ad1154a1fc1e13c0c9020ba3b2efa8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad7ad1154a1fc1e13c0c9020ba3b2efa8">◆ </a></span>BLS_FAIL</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define BLS_FAIL   41</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Invalid signature </p> |
| |
| </div> |
| </div> |
| <a id="acf6e7c8f3dac9ed955df538eeddfe65a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acf6e7c8f3dac9ed955df538eeddfe65a">◆ </a></span>BLS_INVALID_G1</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define BLS_INVALID_G1   42</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Not a valid G1 point on the curve </p> |
| |
| </div> |
| </div> |
| <a id="a0e1f50f8bd36bc147cf2c39e917047aa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0e1f50f8bd36bc147cf2c39e917047aa">◆ </a></span>BLS_INVALID_G2</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define BLS_INVALID_G2   43</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Not a valid G2 point on the curve </p> |
| |
| </div> |
| </div> |
| <a id="a0954a33675757ad87dde21d92a448805"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0954a33675757ad87dde21d92a448805">◆ </a></span>BLS_OK</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define BLS_OK   0</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Function completed without error </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="ab6c79daa940bb9d3228bdfa152fe148e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab6c79daa940bb9d3228bdfa152fe148e">◆ </a></span>BLS_BLS48_ADD_G1()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int BLS_BLS48_ADD_G1 </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structoctet.html">octet</a> * </td> |
| <td class="paramname"><em>R1</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structoctet.html">octet</a> * </td> |
| <td class="paramname"><em>R2</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structoctet.html">octet</a> * </td> |
| <td class="paramname"><em>R</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">R1</td><td>member of G1 </td></tr> |
| <tr><td class="paramname">R2</td><td>member of G1 </td></tr> |
| <tr><td class="paramname">R</td><td>member of G1. R = R1+R2 </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Zero for success or else an error code </dd></dl> |
| |
| </div> |
| </div> |
| <a id="acb44039e4daf6fe37c1284602e91a5f4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acb44039e4daf6fe37c1284602e91a5f4">◆ </a></span>BLS_BLS48_ADD_G2()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int BLS_BLS48_ADD_G2 </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structoctet.html">octet</a> * </td> |
| <td class="paramname"><em>W1</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structoctet.html">octet</a> * </td> |
| <td class="paramname"><em>W2</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structoctet.html">octet</a> * </td> |
| <td class="paramname"><em>W</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">W1</td><td>member of G2 </td></tr> |
| <tr><td class="paramname">W2</td><td>member of G2 </td></tr> |
| <tr><td class="paramname">W</td><td>member of G2. W = W1+W2 </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Zero for success or else an error code </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a7a8481f3854741dee7788aa873fc03d4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7a8481f3854741dee7788aa873fc03d4">◆ </a></span>BLS_BLS48_KEY_PAIR_GENERATE()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int BLS_BLS48_KEY_PAIR_GENERATE </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structcsprng.html">csprng</a> * </td> |
| <td class="paramname"><em>RNG</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structoctet.html">octet</a> * </td> |
| <td class="paramname"><em>S</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structoctet.html">octet</a> * </td> |
| <td class="paramname"><em>W</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">RNG</td><td>Pointer to a cryptographically secure random number generator </td></tr> |
| <tr><td class="paramname">S</td><td>Private key </td></tr> |
| <tr><td class="paramname">W</td><td>Public Key. W = S*G, where G is fixed generator </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Zero for success or else an error code </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aca4a3373e24203541075a1242d469b48"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aca4a3373e24203541075a1242d469b48">◆ </a></span>BLS_BLS48_SIGN()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int BLS_BLS48_SIGN </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structoctet.html">octet</a> * </td> |
| <td class="paramname"><em>SIG</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">char * </td> |
| <td class="paramname"><em>m</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structoctet.html">octet</a> * </td> |
| <td class="paramname"><em>S</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">SIG</td><td>signature </td></tr> |
| <tr><td class="paramname">m</td><td>message to be signed </td></tr> |
| <tr><td class="paramname">S</td><td>Private key </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Zero for success or else an error code </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a1a63c26de2f02ed7529f3df2621d515e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1a63c26de2f02ed7529f3df2621d515e">◆ </a></span>BLS_BLS48_VERIFY()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int BLS_BLS48_VERIFY </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structoctet.html">octet</a> * </td> |
| <td class="paramname"><em>SIG</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">char * </td> |
| <td class="paramname"><em>m</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structoctet.html">octet</a> * </td> |
| <td class="paramname"><em>W</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">SIG</td><td>signature </td></tr> |
| <tr><td class="paramname">m</td><td>message whose signature is to be verified. </td></tr> |
| <tr><td class="paramname">W</td><td>Public key </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Zero for success or else an error code </dd></dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.15 |
| </small></address> |
| </body> |
| </html> |