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 @Returns:
  23 <!-- # Unused Parameters # -->
  24 @dict:
  25
  26
  27 <!-- ##### FUNCTION gras_dict_free ##### -->
  28 <para>
  29
  30 </para>
  31
  32 @dict:
  33 <!-- # Unused Parameters # -->
  34 @Returns:
  35
  36
  37 <!-- ##### FUNCTION gras_dict_set ##### -->
  38 <para>
  39
  40 </para>
  41
  42 @head:
  43 @key:
  44 @data:
  45 @free_ctn:
  46 <!-- # Unused Parameters # -->
  47 @Returns:
  48
  49
  50 <!-- ##### FUNCTION gras_dict_set_ext ##### -->
  51 <para>
  52
  53 </para>
  54
  55 @head:
  56 @key:
  57 @key_len:
  58 @data:
  59 @free_ctn:
  60 <!-- # Unused Parameters # -->
  61 @Returns:
  62
  63
  64 <!-- ##### FUNCTION gras_dict_get ##### -->
  65 <para>
  66
  67 </para>
  68
  69 @head:
  70 @key:
  71 @data:
  72 @Returns:
  73
  74
  75 <!-- ##### FUNCTION gras_dict_get_ext ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @head:
  81 @key:
  82 @key_len:
  83 @data:
  84 @Returns:
  85
  86
  87 <!-- ##### FUNCTION gras_dict_remove ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @head:
  93 @key:
  94 @Returns:
  95
  96
  97 <!-- ##### FUNCTION gras_dict_remove_ext ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @head:
 103 @key:
 104 @key_len:
 105 @Returns:
 106
 107
 108 <!-- ##### FUNCTION gras_dict_dump ##### -->
 109 <para>
 110
 111 </para>
 112
 113 @head:
 114 @output:
 115 <!-- # Unused Parameters # -->
 116 @Returns:
 117
 118
 119 <!-- ##### FUNCTION gras_dict_print ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @data:
 125
 126
 127 <!-- ##### FUNCTION gras_dict_prints ##### -->
 128 <para>
 129
 130 </para>
 131
 132 @data:
 133
 134
 135 <!-- ##### FUNCTION gras_dict_cursor_get_data ##### -->
 136 <para>
 137
 138 </para>
 139
 140 @cursor:
 141 @data:
 142 @Returns:
 143
 144
 145 <!-- ##### FUNCTION gras_dict_cursor_get_key ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @cursor:
 151 @key:
 152 @Returns:
 153
 154
 155 <!-- ##### MACRO gras_dict_foreach ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @dict:
 161 @cursor:
 162 @key:
 163 @data:
 164
 165
 166 <!-- ##### FUNCTION gras_dict_cursor_new ##### -->
 167 <para>
 168
 169 </para>
 170
 171 @head:
 172 @Returns:
 173 <!-- # Unused Parameters # -->
 174 @cursor:
 175
 176
 177 <!-- ##### FUNCTION gras_dict_cursor_free ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @cursor:
 183 <!-- # Unused Parameters # -->
 184 @Returns:
 185
 186
 187 <!-- ##### FUNCTION gras_dict_cursor_rewind ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @cursor:
 193 <!-- # Unused Parameters # -->
 194 @Returns:
 195
 196