crypto/heimdal/doc/doxyout/hx509/man/man3/hx509_env.3

   1 .TH "hx509 enviroment functions" 3 "11 Jan 2012" "Version 1.5.2" "Heimdalx509library" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 hx509 enviroment functions \-
   6 .SS "Functions"
   7
   8 .in +1c
   9 .ti -1c
  10 .RI "int \fBhx509_env_add\fP (hx509_context context, hx509_env *env, const char *key, const char *value)"
  11 .br
  12 .ti -1c
  13 .RI "int \fBhx509_env_add_binding\fP (hx509_context context, hx509_env *env, const char *key, hx509_env list)"
  14 .br
  15 .ti -1c
  16 .RI "const char * \fBhx509_env_lfind\fP (hx509_context context, hx509_env env, const char *key, size_t len)"
  17 .br
  18 .ti -1c
  19 .RI "const char * \fBhx509_env_find\fP (hx509_context context, hx509_env env, const char *key)"
  20 .br
  21 .ti -1c
  22 .RI "hx509_env \fBhx509_env_find_binding\fP (hx509_context context, hx509_env env, const char *key)"
  23 .br
  24 .ti -1c
  25 .RI "void \fBhx509_env_free\fP (hx509_env *env)"
  26 .br
  27 .in -1c
  28 .SH "Detailed Description"
  29 .PP
  30
  31 .SH "Function Documentation"
  32 .PP
  33 .SS "int hx509_env_add (hx509_context context, hx509_env * env, const char * key, const char * value)"
  34 .PP
  35 Add a new key/value pair to the hx509_env.
  36 .PP
  37 \fBParameters:\fP
  38 .RS 4
  39 \fIcontext\fP A hx509 context.
  40 .br
  41 \fIenv\fP enviroment to add the enviroment variable too.
  42 .br
  43 \fIkey\fP key to add
  44 .br
  45 \fIvalue\fP value to add
  46 .RE
  47 .PP
  48 \fBReturns:\fP
  49 .RS 4
  50 An hx509 error code, see \fBhx509_get_error_string()\fP.
  51 .RE
  52 .PP
  53
  54 .SS "int hx509_env_add_binding (hx509_context context, hx509_env * env, const char * key, hx509_env list)"
  55 .PP
  56 Add a new key/binding pair to the hx509_env.
  57 .PP
  58 \fBParameters:\fP
  59 .RS 4
  60 \fIcontext\fP A hx509 context.
  61 .br
  62 \fIenv\fP enviroment to add the enviroment variable too.
  63 .br
  64 \fIkey\fP key to add
  65 .br
  66 \fIlist\fP binding list to add
  67 .RE
  68 .PP
  69 \fBReturns:\fP
  70 .RS 4
  71 An hx509 error code, see \fBhx509_get_error_string()\fP.
  72 .RE
  73 .PP
  74
  75 .SS "const char* hx509_env_find (hx509_context context, hx509_env env, const char * key)"
  76 .PP
  77 Search the hx509_env for a key.
  78 .PP
  79 \fBParameters:\fP
  80 .RS 4
  81 \fIcontext\fP A hx509 context.
  82 .br
  83 \fIenv\fP enviroment to add the enviroment variable too.
  84 .br
  85 \fIkey\fP key to search for.
  86 .RE
  87 .PP
  88 \fBReturns:\fP
  89 .RS 4
  90 the value if the key is found, NULL otherwise.
  91 .RE
  92 .PP
  93
  94 .SS "hx509_env hx509_env_find_binding (hx509_context context, hx509_env env, const char * key)"
  95 .PP
  96 Search the hx509_env for a binding.
  97 .PP
  98 \fBParameters:\fP
  99 .RS 4
 100 \fIcontext\fP A hx509 context.
 101 .br
 102 \fIenv\fP enviroment to add the enviroment variable too.
 103 .br
 104 \fIkey\fP key to search for.
 105 .RE
 106 .PP
 107 \fBReturns:\fP
 108 .RS 4
 109 the binding if the key is found, NULL if not found.
 110 .RE
 111 .PP
 112
 113 .SS "void hx509_env_free (hx509_env * env)"
 114 .PP
 115 Free an hx509_env enviroment context.
 116 .PP
 117 \fBParameters:\fP
 118 .RS 4
 119 \fIenv\fP the enviroment to free.
 120 .RE
 121 .PP
 122
 123 .SS "const char* hx509_env_lfind (hx509_context context, hx509_env env, const char * key, size_t len)"
 124 .PP
 125 Search the hx509_env for a length based key.
 126 .PP
 127 \fBParameters:\fP
 128 .RS 4
 129 \fIcontext\fP A hx509 context.
 130 .br
 131 \fIenv\fP enviroment to add the enviroment variable too.
 132 .br
 133 \fIkey\fP key to search for.
 134 .br
 135 \fIlen\fP length of key.
 136 .RE
 137 .PP
 138 \fBReturns:\fP
 139 .RS 4
 140 the value if the key is found, NULL otherwise.
 141 .RE
 142 .PP
 143