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>Heimdalx509library: hx509 enviroment 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.5.6 --> 12<div class="navigation" id="top"> 13 <div class="tabs"> 14 <ul> 15 <li><a href="index.html"><span>Main Page</span></a></li> 16 <li><a href="pages.html"><span>Related Pages</span></a></li> 17 <li><a href="modules.html"><span>Modules</span></a></li> 18 </ul> 19 </div> 20</div> 21<div class="contents"> 22<h1>hx509 enviroment functions</h1><table border="0" cellpadding="0" cellspacing="0"> 23<tr><td></td></tr> 24<tr><td colspan="2"><br><h2>Functions</h2></td></tr> 25<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__env.html#gd60c343e1400c16df1e2f00d2bdff9e9">hx509_env_add</a> (hx509_context context, hx509_env *env, const char *key, const char *value)</td></tr> 26 27<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__env.html#gf08b9d284b8845a7ce14ef1b21ec1adf">hx509_env_add_binding</a> (hx509_context context, hx509_env *env, const char *key, hx509_env list)</td></tr> 28 29<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__env.html#ga4be057dabba9197ad9ada2594ad36e8">hx509_env_lfind</a> (hx509_context context, hx509_env env, const char *key, size_t len)</td></tr> 30 31<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__env.html#g7e481b337974e7474f8bc7bd9199af13">hx509_env_find</a> (hx509_context context, hx509_env env, const char *key)</td></tr> 32 33<tr><td class="memItemLeft" nowrap align="right" valign="top">hx509_env </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__env.html#g9f2ea48c27a58b690a218c44fd4c90a6">hx509_env_find_binding</a> (hx509_context context, hx509_env env, const char *key)</td></tr> 34 35<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__env.html#gf5587becc945154ca8c6f1795db5c8da">hx509_env_free</a> (hx509_env *env)</td></tr> 36 37</table> 38<hr><a name="_details"></a><h2>Detailed Description</h2> 39<hr><h2>Function Documentation</h2> 40<a class="anchor" name="gd60c343e1400c16df1e2f00d2bdff9e9"></a><!-- doxytag: member="env.c::hx509_env_add" ref="gd60c343e1400c16df1e2f00d2bdff9e9" args="(hx509_context context, hx509_env *env, const char *key, const char *value)" --> 41<div class="memitem"> 42<div class="memproto"> 43 <table class="memname"> 44 <tr> 45 <td class="memname">int hx509_env_add </td> 46 <td>(</td> 47 <td class="paramtype">hx509_context </td> 48 <td class="paramname"> <em>context</em>, </td> 49 </tr> 50 <tr> 51 <td class="paramkey"></td> 52 <td></td> 53 <td class="paramtype">hx509_env * </td> 54 <td class="paramname"> <em>env</em>, </td> 55 </tr> 56 <tr> 57 <td class="paramkey"></td> 58 <td></td> 59 <td class="paramtype">const char * </td> 60 <td class="paramname"> <em>key</em>, </td> 61 </tr> 62 <tr> 63 <td class="paramkey"></td> 64 <td></td> 65 <td class="paramtype">const char * </td> 66 <td class="paramname"> <em>value</em></td><td> </td> 67 </tr> 68 <tr> 69 <td></td> 70 <td>)</td> 71 <td></td><td></td><td></td> 72 </tr> 73 </table> 74</div> 75<div class="memdoc"> 76 77<p> 78Add a new key/value pair to the hx509_env.<p> 79<dl compact><dt><b>Parameters:</b></dt><dd> 80 <table border="0" cellspacing="2" cellpadding="0"> 81 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>A hx509 context. </td></tr> 82 <tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>enviroment to add the enviroment variable too. </td></tr> 83 <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>key to add </td></tr> 84 <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>value to add</td></tr> 85 </table> 86</dl> 87<dl class="return" compact><dt><b>Returns:</b></dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#g15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl> 88 89</div> 90</div><p> 91<a class="anchor" name="gf08b9d284b8845a7ce14ef1b21ec1adf"></a><!-- doxytag: member="env.c::hx509_env_add_binding" ref="gf08b9d284b8845a7ce14ef1b21ec1adf" args="(hx509_context context, hx509_env *env, const char *key, hx509_env list)" --> 92<div class="memitem"> 93<div class="memproto"> 94 <table class="memname"> 95 <tr> 96 <td class="memname">int hx509_env_add_binding </td> 97 <td>(</td> 98 <td class="paramtype">hx509_context </td> 99 <td class="paramname"> <em>context</em>, </td> 100 </tr> 101 <tr> 102 <td class="paramkey"></td> 103 <td></td> 104 <td class="paramtype">hx509_env * </td> 105 <td class="paramname"> <em>env</em>, </td> 106 </tr> 107 <tr> 108 <td class="paramkey"></td> 109 <td></td> 110 <td class="paramtype">const char * </td> 111 <td class="paramname"> <em>key</em>, </td> 112 </tr> 113 <tr> 114 <td class="paramkey"></td> 115 <td></td> 116 <td class="paramtype">hx509_env </td> 117 <td class="paramname"> <em>list</em></td><td> </td> 118 </tr> 119 <tr> 120 <td></td> 121 <td>)</td> 122 <td></td><td></td><td></td> 123 </tr> 124 </table> 125</div> 126<div class="memdoc"> 127 128<p> 129Add a new key/binding pair to the hx509_env.<p> 130<dl compact><dt><b>Parameters:</b></dt><dd> 131 <table border="0" cellspacing="2" cellpadding="0"> 132 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>A hx509 context. </td></tr> 133 <tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>enviroment to add the enviroment variable too. </td></tr> 134 <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>key to add </td></tr> 135 <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>binding list to add</td></tr> 136 </table> 137</dl> 138<dl class="return" compact><dt><b>Returns:</b></dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#g15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl> 139 140</div> 141</div><p> 142<a class="anchor" name="g7e481b337974e7474f8bc7bd9199af13"></a><!-- doxytag: member="env.c::hx509_env_find" ref="g7e481b337974e7474f8bc7bd9199af13" args="(hx509_context context, hx509_env env, const char *key)" --> 143<div class="memitem"> 144<div class="memproto"> 145 <table class="memname"> 146 <tr> 147 <td class="memname">const char* hx509_env_find </td> 148 <td>(</td> 149 <td class="paramtype">hx509_context </td> 150 <td class="paramname"> <em>context</em>, </td> 151 </tr> 152 <tr> 153 <td class="paramkey"></td> 154 <td></td> 155 <td class="paramtype">hx509_env </td> 156 <td class="paramname"> <em>env</em>, </td> 157 </tr> 158 <tr> 159 <td class="paramkey"></td> 160 <td></td> 161 <td class="paramtype">const char * </td> 162 <td class="paramname"> <em>key</em></td><td> </td> 163 </tr> 164 <tr> 165 <td></td> 166 <td>)</td> 167 <td></td><td></td><td></td> 168 </tr> 169 </table> 170</div> 171<div class="memdoc"> 172 173<p> 174Search the hx509_env for a key.<p> 175<dl compact><dt><b>Parameters:</b></dt><dd> 176 <table border="0" cellspacing="2" cellpadding="0"> 177 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>A hx509 context. </td></tr> 178 <tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>enviroment to add the enviroment variable too. </td></tr> 179 <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>key to search for.</td></tr> 180 </table> 181</dl> 182<dl class="return" compact><dt><b>Returns:</b></dt><dd>the value if the key is found, NULL otherwise. </dd></dl> 183 184</div> 185</div><p> 186<a class="anchor" name="g9f2ea48c27a58b690a218c44fd4c90a6"></a><!-- doxytag: member="env.c::hx509_env_find_binding" ref="g9f2ea48c27a58b690a218c44fd4c90a6" args="(hx509_context context, hx509_env env, const char *key)" --> 187<div class="memitem"> 188<div class="memproto"> 189 <table class="memname"> 190 <tr> 191 <td class="memname">hx509_env hx509_env_find_binding </td> 192 <td>(</td> 193 <td class="paramtype">hx509_context </td> 194 <td class="paramname"> <em>context</em>, </td> 195 </tr> 196 <tr> 197 <td class="paramkey"></td> 198 <td></td> 199 <td class="paramtype">hx509_env </td> 200 <td class="paramname"> <em>env</em>, </td> 201 </tr> 202 <tr> 203 <td class="paramkey"></td> 204 <td></td> 205 <td class="paramtype">const char * </td> 206 <td class="paramname"> <em>key</em></td><td> </td> 207 </tr> 208 <tr> 209 <td></td> 210 <td>)</td> 211 <td></td><td></td><td></td> 212 </tr> 213 </table> 214</div> 215<div class="memdoc"> 216 217<p> 218Search the hx509_env for a binding.<p> 219<dl compact><dt><b>Parameters:</b></dt><dd> 220 <table border="0" cellspacing="2" cellpadding="0"> 221 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>A hx509 context. </td></tr> 222 <tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>enviroment to add the enviroment variable too. </td></tr> 223 <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>key to search for.</td></tr> 224 </table> 225</dl> 226<dl class="return" compact><dt><b>Returns:</b></dt><dd>the binding if the key is found, NULL if not found. </dd></dl> 227 228</div> 229</div><p> 230<a class="anchor" name="gf5587becc945154ca8c6f1795db5c8da"></a><!-- doxytag: member="env.c::hx509_env_free" ref="gf5587becc945154ca8c6f1795db5c8da" args="(hx509_env *env)" --> 231<div class="memitem"> 232<div class="memproto"> 233 <table class="memname"> 234 <tr> 235 <td class="memname">void hx509_env_free </td> 236 <td>(</td> 237 <td class="paramtype">hx509_env * </td> 238 <td class="paramname"> <em>env</em> </td> 239 <td> ) </td> 240 <td></td> 241 </tr> 242 </table> 243</div> 244<div class="memdoc"> 245 246<p> 247Free an hx509_env enviroment context.<p> 248<dl compact><dt><b>Parameters:</b></dt><dd> 249 <table border="0" cellspacing="2" cellpadding="0"> 250 <tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>the enviroment to free. </td></tr> 251 </table> 252</dl> 253 254</div> 255</div><p> 256<a class="anchor" name="ga4be057dabba9197ad9ada2594ad36e8"></a><!-- doxytag: member="env.c::hx509_env_lfind" ref="ga4be057dabba9197ad9ada2594ad36e8" args="(hx509_context context, hx509_env env, const char *key, size_t len)" --> 257<div class="memitem"> 258<div class="memproto"> 259 <table class="memname"> 260 <tr> 261 <td class="memname">const char* hx509_env_lfind </td> 262 <td>(</td> 263 <td class="paramtype">hx509_context </td> 264 <td class="paramname"> <em>context</em>, </td> 265 </tr> 266 <tr> 267 <td class="paramkey"></td> 268 <td></td> 269 <td class="paramtype">hx509_env </td> 270 <td class="paramname"> <em>env</em>, </td> 271 </tr> 272 <tr> 273 <td class="paramkey"></td> 274 <td></td> 275 <td class="paramtype">const char * </td> 276 <td class="paramname"> <em>key</em>, </td> 277 </tr> 278 <tr> 279 <td class="paramkey"></td> 280 <td></td> 281 <td class="paramtype">size_t </td> 282 <td class="paramname"> <em>len</em></td><td> </td> 283 </tr> 284 <tr> 285 <td></td> 286 <td>)</td> 287 <td></td><td></td><td></td> 288 </tr> 289 </table> 290</div> 291<div class="memdoc"> 292 293<p> 294Search the hx509_env for a length based key.<p> 295<dl compact><dt><b>Parameters:</b></dt><dd> 296 <table border="0" cellspacing="2" cellpadding="0"> 297 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>A hx509 context. </td></tr> 298 <tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>enviroment to add the enviroment variable too. </td></tr> 299 <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>key to search for. </td></tr> 300 <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>length of key.</td></tr> 301 </table> 302</dl> 303<dl class="return" compact><dt><b>Returns:</b></dt><dd>the value if the key is found, NULL otherwise. </dd></dl> 304 305</div> 306</div><p> 307</div> 308<hr size="1"><address style="text-align: right;"><small> 309Generated on Wed Jan 11 14:07:41 2012 for Heimdalx509library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address> 310</body> 311</html> 312
