Next: String Key Variable Size Value Array Types, Up: String Key Variable Size Value Array Interface [Index]
int x1f4_init_??note(void **, unsigned, struct x1f4_??note_type *)
creates a ??note object, according the $2 bits (see ??note
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_??note_type record pointed to by
the $3 argument are only used if so requested by $2, the $3 argument is not
considered otherwise.
See String Key Variable Size Value Array Types.
See String Key Variable Size Value Array Definitions.
returns 0 for success, one of the defined errors for failure
int x1f4_post_??note(void *, const char *, unsigned, void **)
looks for some $1 associative array node matching the $2 name. Upon look up success, the start address of the found associative array element data is stored at $4. Upon look failure, inserts a new element, corresponding the $2 name, with $3 usable bytes, and stores the start address of the new element data at $4.
returns 0 if a new element was inserted, X1f4_??NOTE_EVER_MATCH if a
match was found, one of the defined errors for failure
int x1f4_find_??note(void *, const char *, void **)
looks for some $1 associative array node matching the $2 name. Upon success, the start address of the found element is stored at $3.
returns 0 if no match was found, non zero otherwise
int x1f4_pass_??note(void *, const char *)
looks for some $1 associative array node matching the $2 name. Upon look up success, deletes the found associative array element.
returns 0 for success (deletion success or nonexistent matching node), one of the defined errors for failure
int x1f4_fini_??note(void **)
destroys the associative array whose address is stored at $1 - dismantles it all and frees the associative array object
returns 0 for success, one of the defined errors for failure