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.14"/> 8 <title>Intel® 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 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 18 $(document).ready(initResizable); 19 /* @license-end */</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® Enhanced Privacy ID SDK</a> 35  <span id="projectnumber">6.0.1</span> 36 </div> 37 </td> 38 </tr> 39 </tbody> 40 </table> 41 </div> 42 <!-- end header part --> 43 <!-- Generated by Doxygen 1.8.14 --> 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 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 57 $(document).ready(function(){initNavTree('group___error_codes.html','');}); 58 /* @license-end */ 59 </script> 60 <div id="doc-content"> 61 <div class="header"> 62 <div class="summary"> 63 <a href="#enum-members">Enumerations</a> | 64 <a href="#func-members">Functions</a> </div> 65 <div class="headertitle"> 66 <div class="title">errors<div class="ingroups"><a class="el" href="group___epid_module.html">epid&nbsp;</a> » <a class="el" href="group___epid_common.html">common</a></div></div> </div> 67 </div><!--header--> 68 <div class="contents"> 69 70 <p>Error reporting interface. 71 <a href="#details">More...</a></p> 72 <table class="memberdecls"> 73 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> 74 Enumerations</h2></td></tr> 75 <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 /> 76   <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a8a6861e14322ca9193498ffc955537f9">kEpidNoErr</a> = 0, 77 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ab45ad60085d03c03ea30b40a0519897e">kEpidSigValid</a> = 0, 78 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aeedd19b8a1cbdecf963f90b4860e02b8">kEpidSigInvalid</a> = 1, 79 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aedd43fb4043bef3b515fc23f1d9a5fe5">kEpidSigRevokedInGroupRl</a> = 2, 80 <br /> 81   <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a1dc7b7e6ff97c7ed9ff4191d76ebd6e1">kEpidSigRevokedInPrivRl</a> = 3, 82 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a43c658cbf0d156850d71ce3f8efd461c">kEpidSigRevokedInSigRl</a> = 4, 83 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a486e052baa99c6c25ae5d5cc710de298">kEpidSigRevokedInVerifierRl</a> = 5, 84 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aa08f0d2e394b37694117a6a32bc71e6e">kEpidErr</a> = -999, 85 <br /> 86   <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a5252da1ff519a098446723e9edd30cc7">kEpidNotImpl</a>, 87 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ad134d6cc95a9dcb1b1a9f9c358047cbf">kEpidBadArgErr</a>, 88 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ab7dfec784192a827a91a4b8a6054d01c">kEpidNoMemErr</a>, 89 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a11a4d2f1c37064eb663de08dc57bcda8">kEpidMemAllocErr</a>, 90 <br /> 91   <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a1739ecb620f4bede2e1b84e52a96cee6">kEpidMathErr</a>, 92 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a893cd0d417b139bb376d09c93695c3f3">kEpidDivByZeroErr</a>, 93 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a83a867b4f71ee13edbfca2f1b72abbec">kEpidUnderflowErr</a>, 94 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ad4d4ff24a7ef2cd7a50b8082265e9ff4">kEpidHashAlgorithmNotSupported</a>, 95 <br /> 96   <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a61234ad9610406da6bf7977afd72a357">kEpidRandMaxIterErr</a>, 97 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a3706f895a660260033b5b91890516c0f">kEpidDuplicateErr</a>, 98 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a94ae9c9b9337afd2fefd3b4f9c3160df">kEpidInconsistentBasenameSetErr</a>, 99 <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ab2768a1a5c4374cb1ac6175c09c73129">kEpidMathQuadraticNonResidueError</a>, 100 <br /> 101   <a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a700953ded1af35781948e8ada6dedf43">kEpidOutOfSequenceError</a> 102 <br /> 103 }</td></tr> 104 <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> 105 <tr class="separator:gafdb27c77c2c4b32c807e326a8a0da360"><td class="memSeparator" colspan="2"> </td></tr> 106 </table><table class="memberdecls"> 107 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 108 Functions</h2></td></tr> 109 <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> 110 <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> 111 <tr class="separator:ga59e8680ce52509302fd58a987e45004d"><td class="memSeparator" colspan="2"> </td></tr> 112 </table> 113 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 114 <p>Error reporting interface. </p> 115 <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> 116 <h2 class="groupheader">Enumeration Type Documentation</h2> 117 <a id="gafdb27c77c2c4b32c807e326a8a0da360"></a> 118 <h2 class="memtitle"><span class="permalink"><a href="#gafdb27c77c2c4b32c807e326a8a0da360">◆ </a></span>EpidStatus</h2> 119 120 <div class="memitem"> 121 <div class="memproto"> 122 <table class="memname"> 123 <tr> 124 <td class="memname">enum <a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a></td> 125 </tr> 126 </table> 127 </div><div class="memdoc"> 128 129 <p>Return status for SDK functions. </p> 130 <p>Convention for status values is as follows:</p><ul> 131 <li>Zero indicates "success"</li> 132 <li>Any positive number indicates "success with status"</li> 133 <li>Any negative number indicates "failure" </li> 134 </ul> 135 <table class="fieldtable"> 136 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a8a6861e14322ca9193498ffc955537f9"></a>kEpidNoErr </td><td class="fielddoc"><p>no error </p> 137 </td></tr> 138 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360ab45ad60085d03c03ea30b40a0519897e"></a>kEpidSigValid </td><td class="fielddoc"><p>Signature is valid. </p> 139 </td></tr> 140 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360aeedd19b8a1cbdecf963f90b4860e02b8"></a>kEpidSigInvalid </td><td class="fielddoc"><p>Signature is invalid. </p> 141 </td></tr> 142 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360aedd43fb4043bef3b515fc23f1d9a5fe5"></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> 143 </td></tr> 144 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a1dc7b7e6ff97c7ed9ff4191d76ebd6e1"></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> 145 </td></tr> 146 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a43c658cbf0d156850d71ce3f8efd461c"></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> 147 </td></tr> 148 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a486e052baa99c6c25ae5d5cc710de298"></a>kEpidSigRevokedInVerifierRl </td><td class="fielddoc"><p>Signature revoked in <a class="el" href="struct_verifier_rl.html">VerifierRl</a>. </p> 149 </td></tr> 150 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360aa08f0d2e394b37694117a6a32bc71e6e"></a>kEpidErr </td><td class="fielddoc"><p>unspecified error </p> 151 </td></tr> 152 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a5252da1ff519a098446723e9edd30cc7"></a>kEpidNotImpl </td><td class="fielddoc"><p>not implemented error </p> 153 </td></tr> 154 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360ad134d6cc95a9dcb1b1a9f9c358047cbf"></a>kEpidBadArgErr </td><td class="fielddoc"><p>incorrect arg to function </p> 155 </td></tr> 156 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360ab7dfec784192a827a91a4b8a6054d01c"></a>kEpidNoMemErr </td><td class="fielddoc"><p>not enough memory for the operation </p> 157 </td></tr> 158 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a11a4d2f1c37064eb663de08dc57bcda8"></a>kEpidMemAllocErr </td><td class="fielddoc"><p>insufficient memory allocated for operation </p> 159 </td></tr> 160 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a1739ecb620f4bede2e1b84e52a96cee6"></a>kEpidMathErr </td><td class="fielddoc"><p>internal math error </p> 161 </td></tr> 162 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a893cd0d417b139bb376d09c93695c3f3"></a>kEpidDivByZeroErr </td><td class="fielddoc"><p>an attempt to divide by zero </p> 163 </td></tr> 164 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a83a867b4f71ee13edbfca2f1b72abbec"></a>kEpidUnderflowErr </td><td class="fielddoc"><p>a value became less than minimum supported level </p> 165 </td></tr> 166 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360ad4d4ff24a7ef2cd7a50b8082265e9ff4"></a>kEpidHashAlgorithmNotSupported </td><td class="fielddoc"><p>unsupported hash algorithm type </p> 167 </td></tr> 168 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a61234ad9610406da6bf7977afd72a357"></a>kEpidRandMaxIterErr </td><td class="fielddoc"><p>reached max iteration for random number generation </p> 169 </td></tr> 170 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a3706f895a660260033b5b91890516c0f"></a>kEpidDuplicateErr </td><td class="fielddoc"><p>argument would add duplicate entry </p> 171 </td></tr> 172 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a94ae9c9b9337afd2fefd3b4f9c3160df"></a>kEpidInconsistentBasenameSetErr </td><td class="fielddoc"><p>set basename conflicts with arguments </p> 173 </td></tr> 174 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360ab2768a1a5c4374cb1ac6175c09c73129"></a>kEpidMathQuadraticNonResidueError </td><td class="fielddoc"><p>quadratic Non-Residue Error </p> 175 </td></tr> 176 <tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a700953ded1af35781948e8ada6dedf43"></a>kEpidOutOfSequenceError </td><td class="fielddoc"><p>operation was performed out of sequence </p> 177 </td></tr> 178 </table> 179 180 </div> 181 </div> 182 <h2 class="groupheader">Function Documentation</h2> 183 <a id="ga59e8680ce52509302fd58a987e45004d"></a> 184 <h2 class="memtitle"><span class="permalink"><a href="#ga59e8680ce52509302fd58a987e45004d">◆ </a></span>EpidStatusToString()</h2> 185 186 <div class="memitem"> 187 <div class="memproto"> 188 <table class="memname"> 189 <tr> 190 <td class="memname">char const* EpidStatusToString </td> 191 <td>(</td> 192 <td class="paramtype"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> </td> 193 <td class="paramname"><em>e</em></td><td>)</td> 194 <td></td> 195 </tr> 196 </table> 197 </div><div class="memdoc"> 198 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 208 </div> 209 </div> 210 </div><!-- contents --> 211 </div><!-- doc-content --> 212 <!-- HTML footer for doxygen 1.8.10--> 213 <!-- start footer part --> 214 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 215 <ul> 216 <li class="footer"> 217 © 2016-2017 Intel Corporation 218 </li> 219 </ul> 220 </div> 221 </body> 222 </html> 223
