workbench/libs/nonvolatile/storenv.c

   1 /*
   2     Copyright © 1995-2006, The AROS Development Team. All rights reserved.
   3     $Id$
   4 */
   5 #include <string.h>
   6 #include <dos/dosextens.h>
   7
   8 /*****************************************************************************
   9
  10     NAME */
  11
  12 // #  define  DEBUG  1
  13 // #include <aros/debug.h>
  14
  15 #include <libraries/nonvolatile.h>
  16 #include <proto/exec.h>
  17 #include <proto/nvdisk.h>
  18
  19 AROS_LH5(LONG, StoreNV,
  20
  21 /*  SYNOPSIS */
  22
  23         AROS_LHA(STRPTR, appName,        A0),
  24         AROS_LHA(STRPTR, itemName,       A1),
  25         AROS_LHA(APTR,   data,           A2),
  26         AROS_LHA(ULONG,  length,         D0),
  27         AROS_LHA(BOOL,   killRequesters, D1),
  28
  29 /*  LOCATION */
  30
  31         struct Library *, nvBase, 7, Nonvolatile)
  32
  33 /*  FUNCTION
  34
  35     Save data in the nonvolatile storage.
  36
  37     INPUTS
  38
  39     appName         --  the application to save an item in the nonvolatile
  40                         storage
  41     itemName        --  the name of the item to save
  42     data            --  the data to save
  43     length          --  number of tens of bytes of the data to save rounded
  44                         upwards (for instance to save 24 bytes specify 3).
  45     killRequesters  --  if TRUE no system requesters will be displayed during
  46                         the operation of this function
  47
  48     RESULT
  49
  50     Indication of the success of the operation
  51
  52         0                --  no error
  53         NVERR_BADNAME    --  'appName' or 'itemName' were not correctly
  54                              specified names
  55         NVERR_WRITEPROT  --  the nonvolatile storage is read only
  56         NVERR_FAIL       --  failure in data saving (storage is full or write
  57                              protected)
  58         NVERR_FATAL      --  fatal error (possible loss of previously saved
  59                              data)
  60
  61     NOTES
  62
  63     The strings 'appName' and 'itemName' should be descripive but short as the
  64     size of the nonvolatile storage may be very limited. The strings may not
  65     contatin the characters ':' or '/'. The maximum length for each of these
  66     strings is 31.
  67
  68     EXAMPLE
  69
  70     BUGS
  71
  72     SEE ALSO
  73
  74     GetCopyNV(), GetNVInfo()
  75
  76     INTERNALS
  77
  78 ******************************************************************************/
  79
  80 {
  81     AROS_LIBFUNC_INIT
  82
  83     struct Process *me = (struct Process *)FindTask(NULL);
  84     APTR            oldReq = me->pr_WindowPtr;
  85     LONG            retval;
  86
  87     if(data == NULL)
  88         return NVERR_FAIL;      /* There is no good (defined) error to
  89                                    report... */
  90
  91     if(appName == NULL || itemName == NULL)
  92         return NVERR_BADNAME;
  93
  94     if(strpbrk(appName, ":/") != NULL ||
  95        strpbrk(itemName, ":/") != NULL)
  96         return NVERR_BADNAME;
  97
  98     if(killRequesters)
  99         me->pr_WindowPtr = (APTR)-1;
 100
 101     //    kprintf("Calling writedata");
 102
 103     retval = WriteNVDData(appName, itemName, data, length*10);
 104
 105     if(killRequesters)
 106         me->pr_WindowPtr = oldReq;
 107
 108     return retval;
 109
 110     AROS_LIBFUNC_EXIT
 111 } /* StoreNV */