Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

gd_error_string(3) [debian man page]

gd_error_string(3)						      GETDATA							gd_error_string(3)

NAME

       gd_error_string -- report a GetData library error

SYNOPSIS

       #include <getdata.h>

       char *gd_error_string(const DIRFILE *dirfile, char *buffer, size_t buflen);

DESCRIPTION

       The gd_error_string() function returns a string describing the last dirfile error encountered while operating on dirfile.

       If  buffer  is  not NULL, the string is written to this memory location.  At most buflen characters will be written. This always includes a
       terminating null byte, even if the error string was truncated.  The numeric dirfile error itself may be obtained by calling gd_error(3).

       If buffer is NULL, gd_error_string() will allocate a string of sufficient length using malloc(3), and buflen is ignored.  In this case, the
       caller should deallocate the returned string using free(3) when it is no longer needed.

       The dirfile argument should point to a DIRFILE object previously created by a call to gd_open(3).

RETURN VALUE

       If  buffer  is  non-NULL, the gd_error_string() function returns buffer, or NULL if buflen is less than one.  Otherwise, it returns a newly
       malloc'd string of sufficient length which should be deallocated by the caller.	The error state of dirfile is unchanged.

SEE ALSO

       gd_open(3), gd_error(3)

Version 0.7.0							  3 November 2010						gd_error_string(3)

Check Out this Related Man Page

gd_nmfields(3)							      GETDATA							    gd_nmfields(3)

NAME

       gd_nmfields -- report the number of metafields in a dirfile

SYNOPSIS

       #include <getdata.h>

       unsigned int gd_nmfields(DIRFILE *dirfile, const char *parent);

DESCRIPTION

       The  gd_nmfields() function queries a dirfile(5) database specified by dirfile and returns the number of metafields defined in the database
       for the parent field specified by parent.

       The dirfile argument must point to a valid DIRFILE object previously created by a call to gd_open(3).

RETURN VALUE

       Upon successful completion, gd_nmfields() returns the number of defined metafields for the given parent.  On error,  it	returns  zero  and
       sets the dirfile error to a non-zero error value.  Possible error values are:

       GD_E_BAD_CODE
	       The supplied parent field code was not found, or referred to a metafield itself.

       GD_E_BAD_DIRFILE
	       The supplied dirfile was invalid.

       The  dirfile error may be retrieved by calling gd_error(3).  A descriptive error string for the last error encountered can be obtained from
       a call to gd_error_string(3).

SEE ALSO

       dirfile(5), gd_open(3), gd_error(3), gd_error_string(3), gd_mfield_list(3), gd_nfields(3), gd_nmfields_by_type(3), gd_nmvectors(3)

Version 0.7.0							   16 July 2010 						    gd_nmfields(3)
Man Page