group___error_codes.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  1. <!-- HTML header for doxygen 1.8.10-->
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  6. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  7. <meta name="generator" content="Doxygen 1.8.11"/>
  8. <title>Intel&reg; Enhanced Privacy ID SDK: errors</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="resize.js"></script>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  21. <link href="epidstyle.css" rel="stylesheet" type="text/css"/>
  22. </head>
  23. <body>
  24. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  25. <div id="titlearea">
  26. <table cellspacing="0" cellpadding="0">
  27. <tbody>
  28. <tr style="height: 56px;">
  29. <td id="projectalign" style="padding-left: 0.5em;">
  30. <div id="projectname"><a
  31. onclick="storeLink('index.html')"
  32. id="projectlink"
  33. class="index.html"
  34. href="index.html">Intel&reg; Enhanced Privacy ID SDK</a>
  35. &#160;<span id="projectnumber">2.0.0</span>
  36. </div>
  37. </td>
  38. </tr>
  39. </tbody>
  40. </table>
  41. </div>
  42. <!-- end header part -->
  43. <!-- Generated by Doxygen 1.8.11 -->
  44. </div><!-- top -->
  45. <div id="side-nav" class="ui-resizable side-nav-resizable">
  46. <div id="nav-tree">
  47. <div id="nav-tree-contents">
  48. <div id="nav-sync" class="sync"></div>
  49. </div>
  50. </div>
  51. <div id="splitbar" style="-moz-user-select:none;"
  52. class="ui-resizable-handle">
  53. </div>
  54. </div>
  55. <script type="text/javascript">
  56. $(document).ready(function(){initNavTree('group___error_codes.html','');});
  57. </script>
  58. <div id="doc-content">
  59. <div class="header">
  60. <div class="summary">
  61. <a href="#enum-members">Enumerations</a> &#124;
  62. <a href="#func-members">Functions</a> </div>
  63. <div class="headertitle">
  64. <div class="title">errors<div class="ingroups"><a class="el" href="group___epid_module.html">epid</a> &raquo; <a class="el" href="group___epid_common.html">common</a></div></div> </div>
  65. </div><!--header-->
  66. <div class="contents">
  67. <p>Error reporting interface.
  68. <a href="#details">More...</a></p>
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  71. Enumerations</h2></td></tr>
  72. <tr class="memitem:gafdb27c77c2c4b32c807e326a8a0da360"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> { <br />
  73. &#160;&#160;<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a8a6861e14322ca9193498ffc955537f9">kEpidNoErr</a> = 0,
  74. <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ab45ad60085d03c03ea30b40a0519897e">kEpidSigValid</a> = 0,
  75. <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aeedd19b8a1cbdecf963f90b4860e02b8">kEpidSigInvalid</a> = 1,
  76. <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a2b38f44424cecd7b432194a2012dc9c7">kEpidSigRevokedinGroupRl</a> = 2,
  77. <br />
  78. &#160;&#160;<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a780a20821863553b88ca617a6fc0f718">kEpidSigRevokedinPrivRl</a> = 3,
  79. <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aff83186b61d48f9fee5f691c5b219bc1">kEpidSigRevokedinSigRl</a> = 4,
  80. <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360addbba767bb884b4459a567056b4d3f86">kEpidSigRevokedinVerifierRl</a> = 5,
  81. <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aa08f0d2e394b37694117a6a32bc71e6e">kEpidErr</a> = -999,
  82. <br />
  83. &#160;&#160;<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a5252da1ff519a098446723e9edd30cc7">kEpidNotImpl</a>,
  84. <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ad134d6cc95a9dcb1b1a9f9c358047cbf">kEpidBadArgErr</a>,
  85. <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ab7dfec784192a827a91a4b8a6054d01c">kEpidNoMemErr</a>,
  86. <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a11a4d2f1c37064eb663de08dc57bcda8">kEpidMemAllocErr</a>,
  87. <br />
  88. &#160;&#160;<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a1739ecb620f4bede2e1b84e52a96cee6">kEpidMathErr</a>,
  89. <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a893cd0d417b139bb376d09c93695c3f3">kEpidDivByZeroErr</a>,
  90. <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a83a867b4f71ee13edbfca2f1b72abbec">kEpidUnderflowErr</a>,
  91. <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ad4d4ff24a7ef2cd7a50b8082265e9ff4">kEpidHashAlgorithmNotSupported</a>,
  92. <br />
  93. &#160;&#160;<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a61234ad9610406da6bf7977afd72a357">kEpidRandMaxIterErr</a>,
  94. <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a3706f895a660260033b5b91890516c0f">kEpidDuplicateErr</a>
  95. <br />
  96. }<tr class="memdesc:gafdb27c77c2c4b32c807e326a8a0da360"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return status for SDK functions. <a href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">More...</a><br /></td></tr>
  97. </td></tr>
  98. <tr class="separator:gafdb27c77c2c4b32c807e326a8a0da360"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table><table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  101. Functions</h2></td></tr>
  102. <tr class="memitem:ga59e8680ce52509302fd58a987e45004d"><td class="memItemLeft" align="right" valign="top">char const *&#160;</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>
  103. <tr class="memdesc:ga59e8680ce52509302fd58a987e45004d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns string representation of error code. <a href="#ga59e8680ce52509302fd58a987e45004d">More...</a><br /></td></tr>
  104. <tr class="separator:ga59e8680ce52509302fd58a987e45004d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. </table>
  106. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  107. <p>Error reporting interface. </p>
  108. <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>
  109. <h2 class="groupheader">Enumeration Type Documentation</h2>
  110. <a class="anchor" id="gafdb27c77c2c4b32c807e326a8a0da360"></a>
  111. <div class="memitem">
  112. <div class="memproto">
  113. <table class="memname">
  114. <tr>
  115. <td class="memname">enum <a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a></td>
  116. </tr>
  117. </table>
  118. </div><div class="memdoc">
  119. <p>Return status for SDK functions. </p>
  120. <p>Convention for status values is as follows:</p><ul>
  121. <li>Zero indicates "success"</li>
  122. <li>Any positive number indicates "success with status"</li>
  123. <li>Any negative number indicates "failure" </li>
  124. </ul>
  125. <table class="fieldtable">
  126. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a8a6861e14322ca9193498ffc955537f9"></a>kEpidNoErr&#160;</td><td class="fielddoc">
  127. <p>no error </p>
  128. </td></tr>
  129. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360ab45ad60085d03c03ea30b40a0519897e"></a>kEpidSigValid&#160;</td><td class="fielddoc">
  130. <p>Signature is valid. </p>
  131. </td></tr>
  132. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360aeedd19b8a1cbdecf963f90b4860e02b8"></a>kEpidSigInvalid&#160;</td><td class="fielddoc">
  133. <p>Signature is invalid. </p>
  134. </td></tr>
  135. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a2b38f44424cecd7b432194a2012dc9c7"></a>kEpidSigRevokedinGroupRl&#160;</td><td class="fielddoc">
  136. <p>Signature revoked in <a class="el" href="struct_group_rl.html" title="group revocation list ">GroupRl</a>. </p>
  137. </td></tr>
  138. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a780a20821863553b88ca617a6fc0f718"></a>kEpidSigRevokedinPrivRl&#160;</td><td class="fielddoc">
  139. <p>Signature revoked in <a class="el" href="struct_priv_rl.html" title="private-key based revocation list. ">PrivRl</a>. </p>
  140. </td></tr>
  141. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360aff83186b61d48f9fee5f691c5b219bc1"></a>kEpidSigRevokedinSigRl&#160;</td><td class="fielddoc">
  142. <p>Signature revoked in <a class="el" href="struct_sig_rl.html" title="signature based revocation list ">SigRl</a>. </p>
  143. </td></tr>
  144. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360addbba767bb884b4459a567056b4d3f86"></a>kEpidSigRevokedinVerifierRl&#160;</td><td class="fielddoc">
  145. <p>Signature revoked in <a class="el" href="struct_verifier_rl.html">VerifierRl</a>. </p>
  146. </td></tr>
  147. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360aa08f0d2e394b37694117a6a32bc71e6e"></a>kEpidErr&#160;</td><td class="fielddoc">
  148. <p>unspecified error </p>
  149. </td></tr>
  150. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a5252da1ff519a098446723e9edd30cc7"></a>kEpidNotImpl&#160;</td><td class="fielddoc">
  151. <p>not implemented error </p>
  152. </td></tr>
  153. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360ad134d6cc95a9dcb1b1a9f9c358047cbf"></a>kEpidBadArgErr&#160;</td><td class="fielddoc">
  154. <p>incorrect arg to function </p>
  155. </td></tr>
  156. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360ab7dfec784192a827a91a4b8a6054d01c"></a>kEpidNoMemErr&#160;</td><td class="fielddoc">
  157. <p>not enough memory for the operation </p>
  158. </td></tr>
  159. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a11a4d2f1c37064eb663de08dc57bcda8"></a>kEpidMemAllocErr&#160;</td><td class="fielddoc">
  160. <p>insufficient memory allocated for operation </p>
  161. </td></tr>
  162. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a1739ecb620f4bede2e1b84e52a96cee6"></a>kEpidMathErr&#160;</td><td class="fielddoc">
  163. <p>internal math error </p>
  164. </td></tr>
  165. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a893cd0d417b139bb376d09c93695c3f3"></a>kEpidDivByZeroErr&#160;</td><td class="fielddoc">
  166. <p>an attempt to divide by zero </p>
  167. </td></tr>
  168. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a83a867b4f71ee13edbfca2f1b72abbec"></a>kEpidUnderflowErr&#160;</td><td class="fielddoc">
  169. <p>a value became less than minimum supported level </p>
  170. </td></tr>
  171. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360ad4d4ff24a7ef2cd7a50b8082265e9ff4"></a>kEpidHashAlgorithmNotSupported&#160;</td><td class="fielddoc">
  172. <p>unsupported hash algorithm type </p>
  173. </td></tr>
  174. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a61234ad9610406da6bf7977afd72a357"></a>kEpidRandMaxIterErr&#160;</td><td class="fielddoc">
  175. <p>reached max iteration for random number generation </p>
  176. </td></tr>
  177. <tr><td class="fieldname"><a class="anchor" id="ggafdb27c77c2c4b32c807e326a8a0da360a3706f895a660260033b5b91890516c0f"></a>kEpidDuplicateErr&#160;</td><td class="fielddoc">
  178. <p>argument would add duplicate entry </p>
  179. </td></tr>
  180. </table>
  181. <dl><dt><b>Examples: </b></dt><dd><a class="el" href="verifysig_8c-example.html#a24">verifysig.c</a>.</dd>
  182. </dl>
  183. </div>
  184. </div>
  185. <h2 class="groupheader">Function Documentation</h2>
  186. <a class="anchor" id="ga59e8680ce52509302fd58a987e45004d"></a>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">char const* EpidStatusToString </td>
  192. <td>(</td>
  193. <td class="paramtype"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a>&#160;</td>
  194. <td class="paramname"><em>e</em></td><td>)</td>
  195. <td></td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. <p>Returns string representation of error code. </p>
  200. <dl class="params"><dt>Parameters</dt><dd>
  201. <table class="params">
  202. <tr><td class="paramname">e</td><td>The status value.</td></tr>
  203. </table>
  204. </dd>
  205. </dl>
  206. <dl class="section return"><dt>Returns</dt><dd>The string describing the status. </dd></dl>
  207. </div>
  208. </div>
  209. </div><!-- contents -->
  210. </div><!-- doc-content -->
  211. <!-- HTML footer for doxygen 1.8.10-->
  212. <!-- start footer part -->
  213. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  214. <ul>
  215. <li class="footer">
  216. &copy; 2016 Intel Corporation
  217. </li>
  218. </ul>
  219. </div>
  220. </body>
  221. </html>