cruft/doc/tmpl/tbx_dico.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Dictionnary
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Data container associating data to a string key.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### FUNCTION gras_dict_new ##### -->
  18 <para>
  19
  20 </para>
  21
  22 @dict:
  23 @Returns:
  24
  25
  26 <!-- ##### FUNCTION gras_dict_free ##### -->
  27 <para>
  28
  29 </para>
  30
  31 @dict:
  32 <!-- # Unused Parameters # -->
  33 @Returns:
  34
  35
  36 <!-- ##### FUNCTION gras_dict_insert ##### -->
  37 <para>
  38
  39 </para>
  40
  41 @head:
  42 @key:
  43 @data:
  44 @free_ctn:
  45 @Returns:
  46
  47
  48 <!-- ##### FUNCTION gras_dict_insert_ext ##### -->
  49 <para>
  50
  51 </para>
  52
  53 @head:
  54 @key:
  55 @key_len:
  56 @data:
  57 @free_ctn:
  58 @Returns:
  59
  60
  61 <!-- ##### FUNCTION gras_dict_retrieve ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @head:
  67 @key:
  68 @data:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION gras_dict_retrieve_ext ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @head:
  78 @key:
  79 @key_len:
  80 @data:
  81 @Returns:
  82
  83
  84 <!-- ##### FUNCTION gras_dict_remove ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @head:
  90 @key:
  91 @Returns:
  92
  93
  94 <!-- ##### FUNCTION gras_dict_remove_ext ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @head:
 100 @key:
 101 @key_len:
 102 @Returns:
 103
 104
 105 <!-- ##### FUNCTION gras_dict_dump ##### -->
 106 <para>
 107
 108 </para>
 109
 110 @head:
 111 @output:
 112 @Returns:
 113
 114
 115 <!-- ##### FUNCTION gras_dict_print ##### -->
 116 <para>
 117
 118 </para>
 119
 120 @data:
 121
 122
 123 <!-- ##### FUNCTION gras_dict_prints ##### -->
 124 <para>
 125
 126 </para>
 127
 128 @data:
 129
 130
 131 <!-- ##### FUNCTION gras_dict_cursor_get_data ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @cursor:
 137 @data:
 138 @Returns:
 139
 140
 141 <!-- ##### FUNCTION gras_dict_cursor_get_key ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @cursor:
 147 @key:
 148 @Returns:
 149
 150
 151 <!-- ##### MACRO gras_dict_foreach ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @dict:
 157 @cursor:
 158 @key:
 159 @data:
 160
 161
 162 <!-- ##### FUNCTION gras_dict_cursor_new ##### -->
 163 <para>
 164
 165 </para>
 166
 167 @head:
 168 @cursor:
 169 @Returns:
 170
 171
 172 <!-- ##### FUNCTION gras_dict_cursor_free ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @cursor:
 178 <!-- # Unused Parameters # -->
 179 @Returns:
 180
 181
 182 <!-- ##### FUNCTION gras_dict_cursor_rewind ##### -->
 183 <para>
 184
 185 </para>
 186
 187 @cursor:
 188 @Returns:
 189
 190