jammy (3) gd_put_constant.3.gz

NAME

       gd_put_carray, gd_put_carray_slice, gd_put_constant — write CONST or CARRAY data to a dirfile database

SYNOPSIS

       #include <getdata.h>

       int gd_put_carray_slice(DIRFILE *dirfile, const char *field_code, unsigned int start, size_t len,
              gd_type_t data_type, const void *data_in);

       int gd_put_carray(DIRFILE *dirfile, const char *field_code, gd_type_t data_type, const void *data_in);

       int gd_put_constant(DIRFILE *dirfile, const char *field_code, gd_type_t data_type, const void *data_in);

DESCRIPTION

       The gd_put_carray_slice() function writes data to a dirfile(5) database specified  by  dirfile  into  the
       CARRAY  scalar  array  field_code.   The  data  in the field is converted from the data type specified by
       data_type, and read from in the user-supplied buffer data_in.  The location of the first element  of  the
       field into which data is stored is given by start, and the number of elements stored is given by len.

       The  gd_put_carray()  function  behaves  similarly,  except  the  whole  scalar  array  is written, as if
       gd_put_carray_slice() were called with  start  equal  zero  and  len  equal  to  the  value  returned  by
       gd_array_len(3).   The  gd_put_constant()  function  is  equivalent to calling gd_put_carray_slice() with
       start equal to zero and len equal to one.  None of these interfaces can write to field representations.

       The argument data_in must point to a valid memory location containing all the data to  be  written.   The
       number  of  elements  which will be stored by gd_put_carray() may be obtained by calling gd_array_len(3).
       Unlike gd_putdata(3), writing data past the end of the field is not permitted.  To add data to a  CARRAY,
       first increase its length by calling gd_alter_carray(3), or another equivalent function.

       The  data_type  argument  should  be  one  of the following symbols, which indicates the type of the data
       pointed to by data_in:

              GD_UINT8   unsigned 8-bit integer

              GD_INT8 signed (two's complement) 8-bit integer

              GD_UINT16
                      unsigned 16-bit integer

              GD_INT16
                      signed (two's complement) 16-bit integer

              GD_UINT32
                      unsigned 32-bit integer

              GD_INT32
                      signed (two's complement) 32-bit integer

              GD_UINT64
                      unsigned 64-bit integer

              GD_INT64
                      signed (two's complement) 64-bit integer

              GD_FLOAT32
                      IEEE-754 standard 32-bit single precision floating point number

              GD_FLOAT64
                      IEEE-754 standard 64-bit double precision floating point number

              GD_COMPLEX64
                      C99-conformant 64-bit single precision complex number

              GD_COMPLEX128
                      C99-conformant 128-bit double precision complex number

       The type of the input data need not be the same as the storage type of the field.  Type  conversion  will
       be  performed  as  necessary  to  return  the requested type.  The dirfile argument must point to a valid
       DIRFILE object previously created by a call to gd_open(3).

RETURN VALUE

       On success, gd_put_carray(), gd_put_carray_slice() and gd_put_constant() return  zero.   On  error,  they
       return a negative-valued error code.  Possible error codes are:

       GD_E_ACCMODE
               The specified dirfile was opened read-only.

       GD_E_ALLOC
               The library was unable to allocate memory.

       GD_E_BAD_CODE
               The field specified by field_code was not found in the database.

       GD_E_BAD_DIRFILE
               The supplied dirfile was invalid.

       GD_E_BAD_FIELD_TYPE
               The supplied field_code was not a CONST nor a CARRAY.

       GD_E_BAD_TYPE
               An invalid data_type was specified.

       GD_E_BOUNDS
               A request for data beyond the end of the field was made.

       GD_E_INTERNAL_ERROR
               An internal error occurred in the library while trying to perform the task.  This indicates a bug
               in the library.  Please report the incident to the maintainer.

       GD_E_PROTECTED
               The fragment containing the constant was protected from change.

       The error code is also stored in the DIRFILE object and may be retrieved after this function  returns  by
       calling   gd_error(3).    A   descriptive  error  string  for  the  error  may  be  obtained  by  calling
       gd_error_string(3).

HISTORY

       The put_constant() function appeared in GetData-0.4.0.

       In GetData-0.7.0, this function was renamed to  gd_put_constant().   The  functions  gd_put_carray()  and
       gd_put_carray_slice() functions also appeared in this release.

       In GetData-0.10.0, the error return from this function changed from -1 to a negative-valued error code.

SEE ALSO

       dirfile(5),  gd_array_len(3),  gd_carrays(3),  gd_error(3),  gd_error_string(3),  gd_get_carray_slice(3),
       gd_open(3), gd_put_constant(3)