---

4.3.1.4 Fixed Length String Key Pointer Value Array Library

• Associative array constructor routine.

  int x1f4_fast_??deck(void *, unsigned, struct x1f4_??deck_type *)
  

  sets up a newly allocated ??deck object, stored at $1, according the $2 bits (see ??deck attribute bit definitions) and $3 setup values

  The setup values in the struct x1f4_??deck_type record pointed to by the $3 argument are only used if so requested by $2, the $3 argument is not considered otherwise.

  See Fixed Length String Key Pointer Value Array Types.

  See Fixed Length String Key Pointer Value Array Definitions.

  returns 0 for success, one of the defined errors for failure

• Associative array regular destructor routine.

  int x1f4_fini_??deck(void **)
  

  destroys the associative array whose address is stored at $1 - dismantles it all and frees the object

  returns 0 for success, one of the defined errors for failure

• Associative array destructor routine.

  int x1f4_flat_??deck(void *)
  

  dismantles the $1 associative array without freeing the memory for the object

  returns 0 for success, one of the defined errors for failure

• Data structure integrity check routine.

  int x1f4_flow_??deck(void *)
  

  checks the $1 associative array for integrity - useful only for debugging this library

  return 0 for success, non 0 for failure to complete the integrity tests

• Associative array regular constructor routine.

  int x1f4_init_??deck(void **, unsigned, struct x1f4_??deck_type *)
  

  creates a ??deck object, according the $2 bits (see ??deck attribute bit definitions) and $3 setup values and stores the address of the newly created associative array at $1

  The setup values in the struct x1f4_??deck_type record pointed to by the $3 argument are only used if so requested by $2, the $3 argument is not considered otherwise.

  See Fixed Length String Key Pointer Value Array Types.

  See Fixed Length String Key Pointer Value Array Definitions.

  returns 0 for success, one of the defined errors for failure

• Data traversal routine.

  int x1f4_list_??deck
      (void *, void *, int (*)(void *, const char *), char *)
  

  calls $3 for each element in the $1 associative array, with $2 and the name corresponding the element as arguments, in this order, until $3 returns non zero. The name will be a null terminated string. The name is constructed in the space pointed to by $4, where at least the key length plus one bytes need be storable.

  returns 0 if $3 was never called (i.e. associative array is empty) or if $3 never returned non zero, the non zero return of $3 otherwise

• Plain data insertion routine.

  int x1f4_post_??deck(void *, const char *, const void *)
  

  looks for some $1 associative array node matching the $2 name. Upon look up failure, inserts a new element, corresponding the $2 name and storing the $3 pointer.

  returns 0 if a new element was inserted, X1f4_??DECK_EVER_MATCH if a match was found, one of the defined errors for failure