1get_mstrings(3)                     GETDATA                    get_mstrings(3)
2
3
4

NAME

6       get_mstrings — retrieve a list of string values from a dirfile
7

SYNOPSIS

9       #include <getdata.h>
10
11       const char **get_mstrings(DIRFILE *dirfile, const char *parent);
12

DESCRIPTION

14       The  get_mstrings() function queries a dirfile(5) database specified by
15       dirfile and returns a read-only list of values of the all  STRING  type
16       metafields for the supplied parent field.
17
18       The  dirfile  argument  must point to a valid DIRFILE object previously
19       created by a call to dirfile_open(3).
20
21       The array returned will be de-allocated by a call  to  dirfile_close(3)
22       and should not be de-allocated by the caller.  The list returned should
23       not be assumed to be in any particular order, although it is guaranteed
24       to  be  in  the  same  order  as  the list of STRING fields returned by
25       get_mfield_list_by_type(3).  The array is terminated by a NULL pointer.
26       The  number  of  strings  in  the  array can be obtained from a call to
27       get_nmfields_by_type(3).
28
29       The caller may not modify any strings in the array, or  the  array  it‐
30       self.  Doing so may cause database corruption.  The pointer returned is
31       guaranteed to be valid until get_mstrings() is called  again  with  the
32       same  arguments,  or  until  the  array  is  deallocated  by  a call to
33       dirfile_close(3).
34
35       A corresponding list of names for these fields may be obtained by call‐
36       ing get_mfield_list_by_type(3).
37
38

RETURN VALUE

40       Upon  successful completion, get_mstrings() returns a pointer to an ar‐
41       ray of strings containing the values of all the STRING  metafields  for
42       the  specified  parent  field.   On  error it returns NULL and sets the
43       dirfile error to a non-zero error value.  Possible error values are:
44
45       GD_E_ALLOC
46               The library was unable to allocate memory.
47
48       GD_E_BAD_CODE
49               The supplied parent field code was not found, or referred to  a
50               metafield itself.
51
52       GD_E_BAD_DIRFILE
53               The supplied dirfile was invalid.
54
55       The dirfile error may be retrieved by calling get_error(3).  A descrip‐
56       tive error string for the last error encountered can be obtained from a
57       call to get_error_string(3).
58

SEE ALSO

60       dirfile(5),    dirfile_open(3),    get_error(3),   get_error_string(3),
61       get_mfield_list_by_type(3), get_nmfields_by_type(3), get_strings(3)
62
63
64
65Version 0.5.0                   8 December 2008                get_mstrings(3)
Impressum