workbench/libs/nonvolatile/storenv.c

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