rom/exec/shutdowna.c

   1 /*
   2     Copyright © 1995-2009, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: ShutdownA() - Shut down the operating system.
   6     Lang: english
   7 */
   8
   9 #include <aros/debug.h>
  10 #include <proto/exec.h>
  11
  12 /*****************************************************************************
  13
  14     NAME */
  15
  16         AROS_LH1(ULONG, ShutdownA,
  17
  18 /*  SYNOPSIS */
  19         AROS_LHA(ULONG, action, D0),
  20
  21 /*  LOCATION */
  22         struct ExecBase *, SysBase, 173, Exec)
  23
  24 /*  FUNCTION
  25         This function will shut down the operating system.
  26
  27     INPUTS
  28         action - what to do:
  29          * SD_ACTION_POWEROFF   - power off the machine.
  30          * SD_ACTION_COLDREBOOT - cold reboot the machine (not only AROS).
  31
  32     RESULT
  33         This function does not return in case of success. Otherwise is returns
  34         zero.
  35
  36     NOTES
  37         It can be quite harmful to call this function. It may be possible that
  38         you will lose data from other tasks not having saved, or disk buffers
  39         not being flushed. Plus you could annoy the (other) users.
  40
  41     EXAMPLE
  42
  43     BUGS
  44
  45     SEE ALSO
  46         ColdReboot()
  47
  48 ******************************************************************************/
  49 {
  50     AROS_LIBFUNC_INIT
  51
  52     /* This is a stub, we don't know what to do here. The actual implementation
  53        is entirely arch-specific. */
  54     return 0;
  55
  56     AROS_LIBFUNC_EXIT
  57 }