cruft/doc/tmpl/core_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_retrieve ##### -->
  49 <para>
  50
  51 </para>
  52
  53 @head:
  54 @key:
  55 @data:
  56 @Returns:
  57
  58
  59 <!-- ##### FUNCTION gras_dict_remove ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @head:
  65 @key:
  66 @Returns:
  67
  68
  69 <!-- ##### FUNCTION gras_dict_dump ##### -->
  70 <para>
  71
  72 </para>
  73
  74 @head:
  75 @output:
  76 @Returns:
  77
  78
  79 <!-- ##### FUNCTION gras_dict_print ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @data:
  85
  86
  87 <!-- ##### FUNCTION gras_dict_prints ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @data:
  93
  94
  95 <!-- ##### FUNCTION gras_dict_cursor_new ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @head:
 101 @cursor:
 102 @Returns:
 103
 104
 105 <!-- ##### FUNCTION gras_dict_cursor_free ##### -->
 106 <para>
 107
 108 </para>
 109
 110 @cursor:
 111 <!-- # Unused Parameters # -->
 112 @Returns:
 113
 114
 115 <!-- ##### FUNCTION gras_dict_cursor_rewind ##### -->
 116 <para>
 117
 118 </para>
 119
 120 @cursor:
 121 @Returns:
 122
 123
 124 <!-- ##### FUNCTION gras_dict_cursor_get_data ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @cursor:
 130 @data:
 131 @Returns:
 132
 133
 134 <!-- ##### FUNCTION gras_dict_cursor_get_key ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @cursor:
 140 @key:
 141 @Returns:
 142
 143