1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 3<title>hx509 error functions</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5<link href="tabs.css" rel="stylesheet" type="text/css"> 6</head><body> 7<p> 8<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a> 9</p> 10<!-- end of header marker --> 11<!-- Generated by Doxygen 1.9.1 --> 12<script type="text/javascript" src="menudata.js"></script> 13<script type="text/javascript" src="menu.js"></script> 14<script type="text/javascript"> 15/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 16$(function() { 17 initMenu('',false,false,'search.php','Search'); 18}); 19/* @license-end */</script> 20<div id="main-nav"></div> 21</div><!-- top --> 22<div class="header"> 23 <div class="summary"> 24<a href="#func-members">Functions</a> </div> 25 <div class="headertitle"> 26<div class="title">hx509 error functions</div> </div> 27</div><!--header--> 28<div class="contents"> 29<table class="memberdecls"> 30<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 31Functions</h2></td></tr> 32<tr class="memitem:ga99a2f278c27355d474bc12e5809ae5ff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__error.html#ga99a2f278c27355d474bc12e5809ae5ff">hx509_clear_error_string</a> (hx509_context context)</td></tr> 33<tr class="separator:ga99a2f278c27355d474bc12e5809ae5ff"><td class="memSeparator" colspan="2"> </td></tr> 34<tr class="memitem:ga4d3505a920021f838cab2228cd197e3d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__error.html#ga4d3505a920021f838cab2228cd197e3d">hx509_set_error_stringv</a> (hx509_context context, int flags, int code, const char *fmt, va_list ap)</td></tr> 35<tr class="separator:ga4d3505a920021f838cab2228cd197e3d"><td class="memSeparator" colspan="2"> </td></tr> 36<tr class="memitem:gad9d4e6e56d2baef65f8c05ee53d6c198"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__error.html#gad9d4e6e56d2baef65f8c05ee53d6c198">hx509_set_error_string</a> (hx509_context context, int flags, int code, const char *fmt,...)</td></tr> 37<tr class="separator:gad9d4e6e56d2baef65f8c05ee53d6c198"><td class="memSeparator" colspan="2"> </td></tr> 38<tr class="memitem:ga15791abff76719acb531223fdcbcac87"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string</a> (hx509_context context, int error_code)</td></tr> 39<tr class="separator:ga15791abff76719acb531223fdcbcac87"><td class="memSeparator" colspan="2"> </td></tr> 40<tr class="memitem:gadd65f91b64ae79e6540708b9ab322992"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__error.html#gadd65f91b64ae79e6540708b9ab322992">hx509_free_error_string</a> (char *str)</td></tr> 41<tr class="separator:gadd65f91b64ae79e6540708b9ab322992"><td class="memSeparator" colspan="2"> </td></tr> 42<tr class="memitem:ga992270111a54a73af9f96216eb548aa4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__error.html#ga992270111a54a73af9f96216eb548aa4">hx509_err</a> (hx509_context context, int exit_code, int error_code, const char *fmt,...)</td></tr> 43<tr class="separator:ga992270111a54a73af9f96216eb548aa4"><td class="memSeparator" colspan="2"> </td></tr> 44</table> 45<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 46<p>See the <a class="el" href="page_error.html">Hx509 error reporting functions</a> for description and examples. </p> 47<h2 class="groupheader">Function Documentation</h2> 48<a id="ga99a2f278c27355d474bc12e5809ae5ff"></a> 49<h2 class="memtitle"><span class="permalink"><a href="#ga99a2f278c27355d474bc12e5809ae5ff">◆ </a></span>hx509_clear_error_string()</h2> 50 51<div class="memitem"> 52<div class="memproto"> 53 <table class="memname"> 54 <tr> 55 <td class="memname">void hx509_clear_error_string </td> 56 <td>(</td> 57 <td class="paramtype">hx509_context </td> 58 <td class="paramname"><em>context</em></td><td>)</td> 59 <td></td> 60 </tr> 61 </table> 62</div><div class="memdoc"> 63<p>Resets the error strings the hx509 context.</p> 64<dl class="params"><dt>Parameters</dt><dd> 65 <table class="params"> 66 <tr><td class="paramname">context</td><td>A hx509 context. </td></tr> 67 </table> 68 </dd> 69</dl> 70 71</div> 72</div> 73<a id="ga992270111a54a73af9f96216eb548aa4"></a> 74<h2 class="memtitle"><span class="permalink"><a href="#ga992270111a54a73af9f96216eb548aa4">◆ </a></span>hx509_err()</h2> 75 76<div class="memitem"> 77<div class="memproto"> 78 <table class="memname"> 79 <tr> 80 <td class="memname">void hx509_err </td> 81 <td>(</td> 82 <td class="paramtype">hx509_context </td> 83 <td class="paramname"><em>context</em>, </td> 84 </tr> 85 <tr> 86 <td class="paramkey"></td> 87 <td></td> 88 <td class="paramtype">int </td> 89 <td class="paramname"><em>exit_code</em>, </td> 90 </tr> 91 <tr> 92 <td class="paramkey"></td> 93 <td></td> 94 <td class="paramtype">int </td> 95 <td class="paramname"><em>error_code</em>, </td> 96 </tr> 97 <tr> 98 <td class="paramkey"></td> 99 <td></td> 100 <td class="paramtype">const char * </td> 101 <td class="paramname"><em>fmt</em>, </td> 102 </tr> 103 <tr> 104 <td class="paramkey"></td> 105 <td></td> 106 <td class="paramtype"> </td> 107 <td class="paramname"><em>...</em> </td> 108 </tr> 109 <tr> 110 <td></td> 111 <td>)</td> 112 <td></td><td></td> 113 </tr> 114 </table> 115</div><div class="memdoc"> 116<p>Print error message and fatally exit from error code</p> 117<dl class="params"><dt>Parameters</dt><dd> 118 <table class="params"> 119 <tr><td class="paramname">context</td><td>A hx509 context. </td></tr> 120 <tr><td class="paramname">exit_code</td><td>exit() code from process. </td></tr> 121 <tr><td class="paramname">error_code</td><td>Error code for the reason to exit. </td></tr> 122 <tr><td class="paramname">fmt</td><td>format string with the exit message. </td></tr> 123 <tr><td class="paramname">...</td><td>argument to format string. </td></tr> 124 </table> 125 </dd> 126</dl> 127 128</div> 129</div> 130<a id="gadd65f91b64ae79e6540708b9ab322992"></a> 131<h2 class="memtitle"><span class="permalink"><a href="#gadd65f91b64ae79e6540708b9ab322992">◆ </a></span>hx509_free_error_string()</h2> 132 133<div class="memitem"> 134<div class="memproto"> 135 <table class="memname"> 136 <tr> 137 <td class="memname">void hx509_free_error_string </td> 138 <td>(</td> 139 <td class="paramtype">char * </td> 140 <td class="paramname"><em>str</em></td><td>)</td> 141 <td></td> 142 </tr> 143 </table> 144</div><div class="memdoc"> 145<p>Free error string returned by <a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>.</p> 146<dl class="params"><dt>Parameters</dt><dd> 147 <table class="params"> 148 <tr><td class="paramname">str</td><td>error string to free. </td></tr> 149 </table> 150 </dd> 151</dl> 152 153</div> 154</div> 155<a id="ga15791abff76719acb531223fdcbcac87"></a> 156<h2 class="memtitle"><span class="permalink"><a href="#ga15791abff76719acb531223fdcbcac87">◆ </a></span>hx509_get_error_string()</h2> 157 158<div class="memitem"> 159<div class="memproto"> 160 <table class="memname"> 161 <tr> 162 <td class="memname">char* hx509_get_error_string </td> 163 <td>(</td> 164 <td class="paramtype">hx509_context </td> 165 <td class="paramname"><em>context</em>, </td> 166 </tr> 167 <tr> 168 <td class="paramkey"></td> 169 <td></td> 170 <td class="paramtype">int </td> 171 <td class="paramname"><em>error_code</em> </td> 172 </tr> 173 <tr> 174 <td></td> 175 <td>)</td> 176 <td></td><td></td> 177 </tr> 178 </table> 179</div><div class="memdoc"> 180<p>Get an error string from context associated with error_code.</p> 181<dl class="params"><dt>Parameters</dt><dd> 182 <table class="params"> 183 <tr><td class="paramname">context</td><td>A hx509 context. </td></tr> 184 <tr><td class="paramname">error_code</td><td>Get error message for this error code.</td></tr> 185 </table> 186 </dd> 187</dl> 188<dl class="section return"><dt>Returns</dt><dd>error string, free with <a class="el" href="group__hx509__error.html#gadd65f91b64ae79e6540708b9ab322992">hx509_free_error_string()</a>. </dd></dl> 189 190</div> 191</div> 192<a id="gad9d4e6e56d2baef65f8c05ee53d6c198"></a> 193<h2 class="memtitle"><span class="permalink"><a href="#gad9d4e6e56d2baef65f8c05ee53d6c198">◆ </a></span>hx509_set_error_string()</h2> 194 195<div class="memitem"> 196<div class="memproto"> 197 <table class="memname"> 198 <tr> 199 <td class="memname">void hx509_set_error_string </td> 200 <td>(</td> 201 <td class="paramtype">hx509_context </td> 202 <td class="paramname"><em>context</em>, </td> 203 </tr> 204 <tr> 205 <td class="paramkey"></td> 206 <td></td> 207 <td class="paramtype">int </td> 208 <td class="paramname"><em>flags</em>, </td> 209 </tr> 210 <tr> 211 <td class="paramkey"></td> 212 <td></td> 213 <td class="paramtype">int </td> 214 <td class="paramname"><em>code</em>, </td> 215 </tr> 216 <tr> 217 <td class="paramkey"></td> 218 <td></td> 219 <td class="paramtype">const char * </td> 220 <td class="paramname"><em>fmt</em>, </td> 221 </tr> 222 <tr> 223 <td class="paramkey"></td> 224 <td></td> 225 <td class="paramtype"> </td> 226 <td class="paramname"><em>...</em> </td> 227 </tr> 228 <tr> 229 <td></td> 230 <td>)</td> 231 <td></td><td></td> 232 </tr> 233 </table> 234</div><div class="memdoc"> 235<p>See <a class="el" href="group__hx509__error.html#ga4d3505a920021f838cab2228cd197e3d">hx509_set_error_stringv()</a>.</p> 236<dl class="params"><dt>Parameters</dt><dd> 237 <table class="params"> 238 <tr><td class="paramname">context</td><td>A hx509 context. </td></tr> 239 <tr><td class="paramname">flags</td><td><ul> 240<li>HX509_ERROR_APPEND appends the error string to the old messages (code is updated). </li> 241</ul> 242</td></tr> 243 <tr><td class="paramname">code</td><td>error code related to error message </td></tr> 244 <tr><td class="paramname">fmt</td><td>error message format </td></tr> 245 <tr><td class="paramname">...</td><td>arguments to error message format </td></tr> 246 </table> 247 </dd> 248</dl> 249 250</div> 251</div> 252<a id="ga4d3505a920021f838cab2228cd197e3d"></a> 253<h2 class="memtitle"><span class="permalink"><a href="#ga4d3505a920021f838cab2228cd197e3d">◆ </a></span>hx509_set_error_stringv()</h2> 254 255<div class="memitem"> 256<div class="memproto"> 257 <table class="memname"> 258 <tr> 259 <td class="memname">void hx509_set_error_stringv </td> 260 <td>(</td> 261 <td class="paramtype">hx509_context </td> 262 <td class="paramname"><em>context</em>, </td> 263 </tr> 264 <tr> 265 <td class="paramkey"></td> 266 <td></td> 267 <td class="paramtype">int </td> 268 <td class="paramname"><em>flags</em>, </td> 269 </tr> 270 <tr> 271 <td class="paramkey"></td> 272 <td></td> 273 <td class="paramtype">int </td> 274 <td class="paramname"><em>code</em>, </td> 275 </tr> 276 <tr> 277 <td class="paramkey"></td> 278 <td></td> 279 <td class="paramtype">const char * </td> 280 <td class="paramname"><em>fmt</em>, </td> 281 </tr> 282 <tr> 283 <td class="paramkey"></td> 284 <td></td> 285 <td class="paramtype">va_list </td> 286 <td class="paramname"><em>ap</em> </td> 287 </tr> 288 <tr> 289 <td></td> 290 <td>)</td> 291 <td></td><td></td> 292 </tr> 293 </table> 294</div><div class="memdoc"> 295<p>Add an error message to the hx509 context.</p> 296<dl class="params"><dt>Parameters</dt><dd> 297 <table class="params"> 298 <tr><td class="paramname">context</td><td>A hx509 context. </td></tr> 299 <tr><td class="paramname">flags</td><td><ul> 300<li>HX509_ERROR_APPEND appends the error string to the old messages (code is updated). </li> 301</ul> 302</td></tr> 303 <tr><td class="paramname">code</td><td>error code related to error message </td></tr> 304 <tr><td class="paramname">fmt</td><td>error message format </td></tr> 305 <tr><td class="paramname">ap</td><td>arguments to error message format </td></tr> 306 </table> 307 </dd> 308</dl> 309 310</div> 311</div> 312</div><!-- contents --> 313<hr size="1"><address style="text-align: right;"><small> 314Generated on Tue Nov 15 2022 14:04:25 for Heimdal x509 library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.9.1</small></address> 315</body> 316</html> 317
