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 environment 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 environment 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:gad60c343e1400c16df1e2f00d2bdff9e9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__env.html#gad60c343e1400c16df1e2f00d2bdff9e9">hx509_env_add</a> (hx509_context context, hx509_env *env, const char *key, const char *value)</td></tr> 33<tr class="separator:gad60c343e1400c16df1e2f00d2bdff9e9"><td class="memSeparator" colspan="2"> </td></tr> 34<tr class="memitem:gaf08b9d284b8845a7ce14ef1b21ec1adf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__env.html#gaf08b9d284b8845a7ce14ef1b21ec1adf">hx509_env_add_binding</a> (hx509_context context, hx509_env *env, const char *key, hx509_env list)</td></tr> 35<tr class="separator:gaf08b9d284b8845a7ce14ef1b21ec1adf"><td class="memSeparator" colspan="2"> </td></tr> 36<tr class="memitem:gaa4be057dabba9197ad9ada2594ad36e8"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__env.html#gaa4be057dabba9197ad9ada2594ad36e8">hx509_env_lfind</a> (hx509_context context, hx509_env env, const char *key, size_t len)</td></tr> 37<tr class="separator:gaa4be057dabba9197ad9ada2594ad36e8"><td class="memSeparator" colspan="2"> </td></tr> 38<tr class="memitem:ga7e481b337974e7474f8bc7bd9199af13"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__env.html#ga7e481b337974e7474f8bc7bd9199af13">hx509_env_find</a> (hx509_context context, hx509_env env, const char *key)</td></tr> 39<tr class="separator:ga7e481b337974e7474f8bc7bd9199af13"><td class="memSeparator" colspan="2"> </td></tr> 40<tr class="memitem:ga9f2ea48c27a58b690a218c44fd4c90a6"><td class="memItemLeft" align="right" valign="top">hx509_env </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__env.html#ga9f2ea48c27a58b690a218c44fd4c90a6">hx509_env_find_binding</a> (hx509_context context, hx509_env env, const char *key)</td></tr> 41<tr class="separator:ga9f2ea48c27a58b690a218c44fd4c90a6"><td class="memSeparator" colspan="2"> </td></tr> 42<tr class="memitem:gaf5587becc945154ca8c6f1795db5c8da"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__env.html#gaf5587becc945154ca8c6f1795db5c8da">hx509_env_free</a> (hx509_env *env)</td></tr> 43<tr class="separator:gaf5587becc945154ca8c6f1795db5c8da"><td class="memSeparator" colspan="2"> </td></tr> 44</table> 45<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 46<h2 class="groupheader">Function Documentation</h2> 47<a id="gad60c343e1400c16df1e2f00d2bdff9e9"></a> 48<h2 class="memtitle"><span class="permalink"><a href="#gad60c343e1400c16df1e2f00d2bdff9e9">◆ </a></span>hx509_env_add()</h2> 49 50<div class="memitem"> 51<div class="memproto"> 52 <table class="memname"> 53 <tr> 54 <td class="memname">int hx509_env_add </td> 55 <td>(</td> 56 <td class="paramtype">hx509_context </td> 57 <td class="paramname"><em>context</em>, </td> 58 </tr> 59 <tr> 60 <td class="paramkey"></td> 61 <td></td> 62 <td class="paramtype">hx509_env * </td> 63 <td class="paramname"><em>env</em>, </td> 64 </tr> 65 <tr> 66 <td class="paramkey"></td> 67 <td></td> 68 <td class="paramtype">const char * </td> 69 <td class="paramname"><em>key</em>, </td> 70 </tr> 71 <tr> 72 <td class="paramkey"></td> 73 <td></td> 74 <td class="paramtype">const char * </td> 75 <td class="paramname"><em>value</em> </td> 76 </tr> 77 <tr> 78 <td></td> 79 <td>)</td> 80 <td></td><td></td> 81 </tr> 82 </table> 83</div><div class="memdoc"> 84<p>Add a new key/value pair to the hx509_env.</p> 85<dl class="params"><dt>Parameters</dt><dd> 86 <table class="params"> 87 <tr><td class="paramname">context</td><td>A hx509 context. </td></tr> 88 <tr><td class="paramname">env</td><td>environment to add the environment variable too. </td></tr> 89 <tr><td class="paramname">key</td><td>key to add </td></tr> 90 <tr><td class="paramname">value</td><td>value to add</td></tr> 91 </table> 92 </dd> 93</dl> 94<dl class="section return"><dt>Returns</dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl> 95 96</div> 97</div> 98<a id="gaf08b9d284b8845a7ce14ef1b21ec1adf"></a> 99<h2 class="memtitle"><span class="permalink"><a href="#gaf08b9d284b8845a7ce14ef1b21ec1adf">◆ </a></span>hx509_env_add_binding()</h2> 100 101<div class="memitem"> 102<div class="memproto"> 103 <table class="memname"> 104 <tr> 105 <td class="memname">int hx509_env_add_binding </td> 106 <td>(</td> 107 <td class="paramtype">hx509_context </td> 108 <td class="paramname"><em>context</em>, </td> 109 </tr> 110 <tr> 111 <td class="paramkey"></td> 112 <td></td> 113 <td class="paramtype">hx509_env * </td> 114 <td class="paramname"><em>env</em>, </td> 115 </tr> 116 <tr> 117 <td class="paramkey"></td> 118 <td></td> 119 <td class="paramtype">const char * </td> 120 <td class="paramname"><em>key</em>, </td> 121 </tr> 122 <tr> 123 <td class="paramkey"></td> 124 <td></td> 125 <td class="paramtype">hx509_env </td> 126 <td class="paramname"><em>list</em> </td> 127 </tr> 128 <tr> 129 <td></td> 130 <td>)</td> 131 <td></td><td></td> 132 </tr> 133 </table> 134</div><div class="memdoc"> 135<p>Add a new key/binding pair to the hx509_env.</p> 136<dl class="params"><dt>Parameters</dt><dd> 137 <table class="params"> 138 <tr><td class="paramname">context</td><td>A hx509 context. </td></tr> 139 <tr><td class="paramname">env</td><td>environment to add the environment variable too. </td></tr> 140 <tr><td class="paramname">key</td><td>key to add </td></tr> 141 <tr><td class="paramname">list</td><td>binding list to add</td></tr> 142 </table> 143 </dd> 144</dl> 145<dl class="section return"><dt>Returns</dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl> 146 147</div> 148</div> 149<a id="ga7e481b337974e7474f8bc7bd9199af13"></a> 150<h2 class="memtitle"><span class="permalink"><a href="#ga7e481b337974e7474f8bc7bd9199af13">◆ </a></span>hx509_env_find()</h2> 151 152<div class="memitem"> 153<div class="memproto"> 154 <table class="memname"> 155 <tr> 156 <td class="memname">const char* hx509_env_find </td> 157 <td>(</td> 158 <td class="paramtype">hx509_context </td> 159 <td class="paramname"><em>context</em>, </td> 160 </tr> 161 <tr> 162 <td class="paramkey"></td> 163 <td></td> 164 <td class="paramtype">hx509_env </td> 165 <td class="paramname"><em>env</em>, </td> 166 </tr> 167 <tr> 168 <td class="paramkey"></td> 169 <td></td> 170 <td class="paramtype">const char * </td> 171 <td class="paramname"><em>key</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>Search the hx509_env for a key.</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">env</td><td>environment to add the environment variable too. </td></tr> 185 <tr><td class="paramname">key</td><td>key to search for.</td></tr> 186 </table> 187 </dd> 188</dl> 189<dl class="section return"><dt>Returns</dt><dd>the value if the key is found, NULL otherwise. </dd></dl> 190 191</div> 192</div> 193<a id="ga9f2ea48c27a58b690a218c44fd4c90a6"></a> 194<h2 class="memtitle"><span class="permalink"><a href="#ga9f2ea48c27a58b690a218c44fd4c90a6">◆ </a></span>hx509_env_find_binding()</h2> 195 196<div class="memitem"> 197<div class="memproto"> 198 <table class="memname"> 199 <tr> 200 <td class="memname">hx509_env hx509_env_find_binding </td> 201 <td>(</td> 202 <td class="paramtype">hx509_context </td> 203 <td class="paramname"><em>context</em>, </td> 204 </tr> 205 <tr> 206 <td class="paramkey"></td> 207 <td></td> 208 <td class="paramtype">hx509_env </td> 209 <td class="paramname"><em>env</em>, </td> 210 </tr> 211 <tr> 212 <td class="paramkey"></td> 213 <td></td> 214 <td class="paramtype">const char * </td> 215 <td class="paramname"><em>key</em> </td> 216 </tr> 217 <tr> 218 <td></td> 219 <td>)</td> 220 <td></td><td></td> 221 </tr> 222 </table> 223</div><div class="memdoc"> 224<p>Search the hx509_env for a binding.</p> 225<dl class="params"><dt>Parameters</dt><dd> 226 <table class="params"> 227 <tr><td class="paramname">context</td><td>A hx509 context. </td></tr> 228 <tr><td class="paramname">env</td><td>environment to add the environment variable too. </td></tr> 229 <tr><td class="paramname">key</td><td>key to search for.</td></tr> 230 </table> 231 </dd> 232</dl> 233<dl class="section return"><dt>Returns</dt><dd>the binding if the key is found, NULL if not found. </dd></dl> 234 235</div> 236</div> 237<a id="gaf5587becc945154ca8c6f1795db5c8da"></a> 238<h2 class="memtitle"><span class="permalink"><a href="#gaf5587becc945154ca8c6f1795db5c8da">◆ </a></span>hx509_env_free()</h2> 239 240<div class="memitem"> 241<div class="memproto"> 242 <table class="memname"> 243 <tr> 244 <td class="memname">void hx509_env_free </td> 245 <td>(</td> 246 <td class="paramtype">hx509_env * </td> 247 <td class="paramname"><em>env</em></td><td>)</td> 248 <td></td> 249 </tr> 250 </table> 251</div><div class="memdoc"> 252<p>Free an hx509_env environment context.</p> 253<dl class="params"><dt>Parameters</dt><dd> 254 <table class="params"> 255 <tr><td class="paramname">env</td><td>the environment to free. </td></tr> 256 </table> 257 </dd> 258</dl> 259 260</div> 261</div> 262<a id="gaa4be057dabba9197ad9ada2594ad36e8"></a> 263<h2 class="memtitle"><span class="permalink"><a href="#gaa4be057dabba9197ad9ada2594ad36e8">◆ </a></span>hx509_env_lfind()</h2> 264 265<div class="memitem"> 266<div class="memproto"> 267 <table class="memname"> 268 <tr> 269 <td class="memname">const char* hx509_env_lfind </td> 270 <td>(</td> 271 <td class="paramtype">hx509_context </td> 272 <td class="paramname"><em>context</em>, </td> 273 </tr> 274 <tr> 275 <td class="paramkey"></td> 276 <td></td> 277 <td class="paramtype">hx509_env </td> 278 <td class="paramname"><em>env</em>, </td> 279 </tr> 280 <tr> 281 <td class="paramkey"></td> 282 <td></td> 283 <td class="paramtype">const char * </td> 284 <td class="paramname"><em>key</em>, </td> 285 </tr> 286 <tr> 287 <td class="paramkey"></td> 288 <td></td> 289 <td class="paramtype">size_t </td> 290 <td class="paramname"><em>len</em> </td> 291 </tr> 292 <tr> 293 <td></td> 294 <td>)</td> 295 <td></td><td></td> 296 </tr> 297 </table> 298</div><div class="memdoc"> 299<p>Search the hx509_env for a length based key.</p> 300<dl class="params"><dt>Parameters</dt><dd> 301 <table class="params"> 302 <tr><td class="paramname">context</td><td>A hx509 context. </td></tr> 303 <tr><td class="paramname">env</td><td>environment to add the environment variable too. </td></tr> 304 <tr><td class="paramname">key</td><td>key to search for. </td></tr> 305 <tr><td class="paramname">len</td><td>length of key.</td></tr> 306 </table> 307 </dd> 308</dl> 309<dl class="section return"><dt>Returns</dt><dd>the value if the key is found, NULL otherwise. </dd></dl> 310 311</div> 312</div> 313</div><!-- contents --> 314<hr size="1"><address style="text-align: right;"><small> 315Generated 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> 316</body> 317</html> 318
