doc/html/group___error_codes.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222

<!-- 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.14"/>
<title>Intel&reg; 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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</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&reg; Enhanced Privacy ID SDK</a>
&#160;<span id="projectnumber">6.0.1</span>
</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group___error_codes.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<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&amp;nbsp;</a> &raquo; <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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> { <br />
&#160;&#160;<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#ggafdb27c77c2c4b32c807e326a8a0da360aedd43fb4043bef3b515fc23f1d9a5fe5">kEpidSigRevokedInGroupRl</a> = 2, 
<br />
&#160;&#160;<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a1dc7b7e6ff97c7ed9ff4191d76ebd6e1">kEpidSigRevokedInPrivRl</a> = 3, 
<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a43c658cbf0d156850d71ce3f8efd461c">kEpidSigRevokedInSigRl</a> = 4, 
<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a486e052baa99c6c25ae5d5cc710de298">kEpidSigRevokedInVerifierRl</a> = 5, 
<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360aa08f0d2e394b37694117a6a32bc71e6e">kEpidErr</a> = -999, 
<br />
&#160;&#160;<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 />
&#160;&#160;<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 />
&#160;&#160;<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a61234ad9610406da6bf7977afd72a357">kEpidRandMaxIterErr</a>, 
<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a3706f895a660260033b5b91890516c0f">kEpidDuplicateErr</a>, 
<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a94ae9c9b9337afd2fefd3b4f9c3160df">kEpidInconsistentBasenameSetErr</a>, 
<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360ab2768a1a5c4374cb1ac6175c09c73129">kEpidMathQuadraticNonResidueError</a>, 
<br />
&#160;&#160;<a class="el" href="group___error_codes.html#ggafdb27c77c2c4b32c807e326a8a0da360a700953ded1af35781948e8ada6dedf43">kEpidOutOfSequenceError</a>
<br />
 }</td></tr>
<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>
<tr class="separator:gafdb27c77c2c4b32c807e326a8a0da360"><td class="memSeparator" colspan="2">&#160;</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  *&#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>
<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>
<tr class="separator:ga59e8680ce52509302fd58a987e45004d"><td class="memSeparator" colspan="2">&#160;</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 id="gafdb27c77c2c4b32c807e326a8a0da360"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafdb27c77c2c4b32c807e326a8a0da360">&#9670;&nbsp;</a></span>EpidStatus</h2>

<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 id="ggafdb27c77c2c4b32c807e326a8a0da360a8a6861e14322ca9193498ffc955537f9"></a>kEpidNoErr&#160;</td><td class="fielddoc"><p>no error </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360ab45ad60085d03c03ea30b40a0519897e"></a>kEpidSigValid&#160;</td><td class="fielddoc"><p>Signature is valid. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360aeedd19b8a1cbdecf963f90b4860e02b8"></a>kEpidSigInvalid&#160;</td><td class="fielddoc"><p>Signature is invalid. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360aedd43fb4043bef3b515fc23f1d9a5fe5"></a>kEpidSigRevokedInGroupRl&#160;</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 id="ggafdb27c77c2c4b32c807e326a8a0da360a1dc7b7e6ff97c7ed9ff4191d76ebd6e1"></a>kEpidSigRevokedInPrivRl&#160;</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 id="ggafdb27c77c2c4b32c807e326a8a0da360a43c658cbf0d156850d71ce3f8efd461c"></a>kEpidSigRevokedInSigRl&#160;</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 id="ggafdb27c77c2c4b32c807e326a8a0da360a486e052baa99c6c25ae5d5cc710de298"></a>kEpidSigRevokedInVerifierRl&#160;</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 id="ggafdb27c77c2c4b32c807e326a8a0da360aa08f0d2e394b37694117a6a32bc71e6e"></a>kEpidErr&#160;</td><td class="fielddoc"><p>unspecified error </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a5252da1ff519a098446723e9edd30cc7"></a>kEpidNotImpl&#160;</td><td class="fielddoc"><p>not implemented error </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360ad134d6cc95a9dcb1b1a9f9c358047cbf"></a>kEpidBadArgErr&#160;</td><td class="fielddoc"><p>incorrect arg to function </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360ab7dfec784192a827a91a4b8a6054d01c"></a>kEpidNoMemErr&#160;</td><td class="fielddoc"><p>not enough memory for the operation </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a11a4d2f1c37064eb663de08dc57bcda8"></a>kEpidMemAllocErr&#160;</td><td class="fielddoc"><p>insufficient memory allocated for operation </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a1739ecb620f4bede2e1b84e52a96cee6"></a>kEpidMathErr&#160;</td><td class="fielddoc"><p>internal math error </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a893cd0d417b139bb376d09c93695c3f3"></a>kEpidDivByZeroErr&#160;</td><td class="fielddoc"><p>an attempt to divide by zero </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a83a867b4f71ee13edbfca2f1b72abbec"></a>kEpidUnderflowErr&#160;</td><td class="fielddoc"><p>a value became less than minimum supported level </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360ad4d4ff24a7ef2cd7a50b8082265e9ff4"></a>kEpidHashAlgorithmNotSupported&#160;</td><td class="fielddoc"><p>unsupported hash algorithm type </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a61234ad9610406da6bf7977afd72a357"></a>kEpidRandMaxIterErr&#160;</td><td class="fielddoc"><p>reached max iteration for random number generation </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a3706f895a660260033b5b91890516c0f"></a>kEpidDuplicateErr&#160;</td><td class="fielddoc"><p>argument would add duplicate entry </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a94ae9c9b9337afd2fefd3b4f9c3160df"></a>kEpidInconsistentBasenameSetErr&#160;</td><td class="fielddoc"><p>set basename conflicts with arguments </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360ab2768a1a5c4374cb1ac6175c09c73129"></a>kEpidMathQuadraticNonResidueError&#160;</td><td class="fielddoc"><p>quadratic Non-Residue Error </p>
</td></tr>
<tr><td class="fieldname"><a id="ggafdb27c77c2c4b32c807e326a8a0da360a700953ded1af35781948e8ada6dedf43"></a>kEpidOutOfSequenceError&#160;</td><td class="fielddoc"><p>operation was performed out of sequence </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga59e8680ce52509302fd58a987e45004d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga59e8680ce52509302fd58a987e45004d">&#9670;&nbsp;</a></span>EpidStatusToString()</h2>

<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>&#160;</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">
      &copy; 2016-2017 Intel Corporation
    </li>
  </ul>
</div>
</body>
</html>