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