123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225 |
- <!-- HTML header for doxygen 1.8.10-->
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
- <title>Intel® Enhanced Privacy ID SDK: errors</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="navtree.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="resize.js"></script>
- <script type="text/javascript" src="navtreedata.js"></script>
- <script type="text/javascript" src="navtree.js"></script>
- <script type="text/javascript">
- $(document).ready(initResizable);
- $(window).load(resizeHeight);
- </script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="epidstyle.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"><a
- onclick="storeLink('index.html')"
- id="projectlink"
- class="index.html"
- href="index.html">Intel® Enhanced Privacy ID SDK</a>
-  <span id="projectnumber">2.0.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.11 -->
- </div><!-- top -->
- <div id="side-nav" class="ui-resizable side-nav-resizable">
- <div id="nav-tree">
- <div id="nav-tree-contents">
- <div id="nav-sync" class="sync"></div>
- </div>
- </div>
- <div id="splitbar" style="-moz-user-select:none;"
- class="ui-resizable-handle">
- </div>
- </div>
- <script type="text/javascript">
- $(document).ready(function(){initNavTree('group___error_codes.html','');});
- </script>
- <div id="doc-content">
- <div class="header">
- <div class="summary">
- <a href="#enum-members">Enumerations</a> |
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">errors<div class="ingroups"><a class="el" href="group___epid_module.html">epid</a> » <a class="el" href="group___epid_common.html">common</a></div></div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Error reporting interface.
- <a href="#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
- Enumerations</h2></td></tr>
- <tr class="memitem:gafdb27c77c2c4b32c807e326a8a0da360"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> { <br />
-   <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a8a6861e14322ca9193498ffc955537f9">kEpidNoErr</a> = 0,
- <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ab45ad60085d03c03ea30b40a0519897e">kEpidSigValid</a> = 0,
- <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aeedd19b8a1cbdecf963f90b4860e02b8">kEpidSigInvalid</a> = 1,
- <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a2b38f44424cecd7b432194a2012dc9c7">kEpidSigRevokedinGroupRl</a> = 2,
- <br />
-   <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a780a20821863553b88ca617a6fc0f718">kEpidSigRevokedinPrivRl</a> = 3,
- <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aff83186b61d48f9fee5f691c5b219bc1">kEpidSigRevokedinSigRl</a> = 4,
- <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360addbba767bb884b4459a567056b4d3f86">kEpidSigRevokedinVerifierRl</a> = 5,
- <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aa08f0d2e394b37694117a6a32bc71e6e">kEpidErr</a> = -999,
- <br />
-   <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a5252da1ff519a098446723e9edd30cc7">kEpidNotImpl</a>,
- <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ad134d6cc95a9dcb1b1a9f9c358047cbf">kEpidBadArgErr</a>,
- <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ab7dfec784192a827a91a4b8a6054d01c">kEpidNoMemErr</a>,
- <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a11a4d2f1c37064eb663de08dc57bcda8">kEpidMemAllocErr</a>,
- <br />
-   <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a1739ecb620f4bede2e1b84e52a96cee6">kEpidMathErr</a>,
- <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a893cd0d417b139bb376d09c93695c3f3">kEpidDivByZeroErr</a>,
- <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a83a867b4f71ee13edbfca2f1b72abbec">kEpidUnderflowErr</a>,
- <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ad4d4ff24a7ef2cd7a50b8082265e9ff4">kEpidHashAlgorithmNotSupported</a>,
- <br />
-   <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a61234ad9610406da6bf7977afd72a357">kEpidRandMaxIterErr</a>,
- <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a3706f895a660260033b5b91890516c0f">kEpidDuplicateErr</a>
- <br />
- }<tr class="memdesc:gafdb27c77c2c4b32c807e326a8a0da360"><td class="mdescLeft"> </td><td class="mdescRight">Return status for SDK functions. <a href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">More...</a><br /></td></tr>
- </td></tr>
- <tr class="separator:gafdb27c77c2c4b32c807e326a8a0da360"><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:ga59e8680ce52509302fd58a987e45004d"><td class="memItemLeft" align="right" valign="top">char const * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___error_codes.html#ga59e8680ce52509302fd58a987e45004d">EpidStatusToString</a> (<a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> e)</td></tr>
- <tr class="memdesc:ga59e8680ce52509302fd58a987e45004d"><td class="mdescLeft"> </td><td class="mdescRight">Returns string representation of error code. <a href="#ga59e8680ce52509302fd58a987e45004d">More...</a><br /></td></tr>
- <tr class="separator:ga59e8680ce52509302fd58a987e45004d"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>Error reporting interface. </p>
- <p>This module defines the return status type. It also provides tools for interactions with status values, such as converting them to a string. </p>
- <h2 class="groupheader">Enumeration Type Documentation</h2>
- <a class="anchor" id="gafdb27c77c2c4b32c807e326a8a0da360"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">enum <a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return status for SDK functions. </p>
- <p>Convention for status values is as follows:</p><ul>
- <li>Zero indicates "success"</li>
- <li>Any positive number indicates "success with status"</li>
- <li>Any negative number indicates "failure" </li>
- </ul>
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a8a6861e14322ca9193498ffc955537f9"></a>kEpidNoErr </td><td class="fielddoc">
- <p>no error </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360ab45ad60085d03c03ea30b40a0519897e"></a>kEpidSigValid </td><td class="fielddoc">
- <p>Signature is valid. </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360aeedd19b8a1cbdecf963f90b4860e02b8"></a>kEpidSigInvalid </td><td class="fielddoc">
- <p>Signature is invalid. </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a2b38f44424cecd7b432194a2012dc9c7"></a>kEpidSigRevokedinGroupRl </td><td class="fielddoc">
- <p>Signature revoked in <a class="el" href="struct_group_rl.html" title="group revocation list ">GroupRl</a>. </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a780a20821863553b88ca617a6fc0f718"></a>kEpidSigRevokedinPrivRl </td><td class="fielddoc">
- <p>Signature revoked in <a class="el" href="struct_priv_rl.html" title="private-key based revocation list. ">PrivRl</a>. </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360aff83186b61d48f9fee5f691c5b219bc1"></a>kEpidSigRevokedinSigRl </td><td class="fielddoc">
- <p>Signature revoked in <a class="el" href="struct_sig_rl.html" title="signature based revocation list ">SigRl</a>. </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360addbba767bb884b4459a567056b4d3f86"></a>kEpidSigRevokedinVerifierRl </td><td class="fielddoc">
- <p>Signature revoked in <a class="el" href="struct_verifier_rl.html">VerifierRl</a>. </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360aa08f0d2e394b37694117a6a32bc71e6e"></a>kEpidErr </td><td class="fielddoc">
- <p>unspecified error </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a5252da1ff519a098446723e9edd30cc7"></a>kEpidNotImpl </td><td class="fielddoc">
- <p>not implemented error </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360ad134d6cc95a9dcb1b1a9f9c358047cbf"></a>kEpidBadArgErr </td><td class="fielddoc">
- <p>incorrect arg to function </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360ab7dfec784192a827a91a4b8a6054d01c"></a>kEpidNoMemErr </td><td class="fielddoc">
- <p>not enough memory for the operation </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a11a4d2f1c37064eb663de08dc57bcda8"></a>kEpidMemAllocErr </td><td class="fielddoc">
- <p>insufficient memory allocated for operation </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a1739ecb620f4bede2e1b84e52a96cee6"></a>kEpidMathErr </td><td class="fielddoc">
- <p>internal math error </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a893cd0d417b139bb376d09c93695c3f3"></a>kEpidDivByZeroErr </td><td class="fielddoc">
- <p>an attempt to divide by zero </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a83a867b4f71ee13edbfca2f1b72abbec"></a>kEpidUnderflowErr </td><td class="fielddoc">
- <p>a value became less than minimum supported level </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360ad4d4ff24a7ef2cd7a50b8082265e9ff4"></a>kEpidHashAlgorithmNotSupported </td><td class="fielddoc">
- <p>unsupported hash algorithm type </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a61234ad9610406da6bf7977afd72a357"></a>kEpidRandMaxIterErr </td><td class="fielddoc">
- <p>reached max iteration for random number generation </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a3706f895a660260033b5b91890516c0f"></a>kEpidDuplicateErr </td><td class="fielddoc">
- <p>argument would add duplicate entry </p>
- </td></tr>
- </table>
- <dl><dt><b>Examples: </b></dt><dd><a class="el" href="verifysig_8c-example.html#a24">verifysig.c</a>.</dd>
- </dl>
- </div>
- </div>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="ga59e8680ce52509302fd58a987e45004d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">char const* EpidStatusToString </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> </td>
- <td class="paramname"><em>e</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns string representation of error code. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">e</td><td>The status value.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The string describing the status. </dd></dl>
- </div>
- </div>
- </div><!-- contents -->
- </div><!-- doc-content -->
- <!-- HTML footer for doxygen 1.8.10-->
- <!-- start footer part -->
- <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <li class="footer">
- © 2016 Intel Corporation
- </li>
- </ul>
- </div>
- </body>
- </html>
|