workbench/c/shellcommands/Quit.c

   1 /*
   2     Copyright © 1995-2015, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: English
   7 */
   8
   9 /******************************************************************************
  10
  11     NAME
  12
  13         Quit
  14
  15     SYNOPSIS
  16
  17         RC/N
  18
  19     LOCATION
  20
  21         C:
  22
  23     FUNCTION
  24
  25         Exits a script with the given return code. It's recommended that you
  26         use the standard return codes 5, 10 and 20.
  27
  28     INPUTS
  29
  30         RC   --  the return code. Defaults to 0.
  31
  32     RESULT
  33
  34     NOTES
  35         If this command is called in a script that is executed from another
  36         script, the entire series of nested scripts will stop.
  37
  38     EXAMPLE
  39
  40     BUGS
  41
  42     SEE ALSO
  43
  44     INTERNALS
  45
  46 ******************************************************************************/
  47
  48 #include <proto/dos.h>
  49 #include <dos/dos.h>
  50 #include <dos/dosextens.h>
  51 #include <dos/rdargs.h>
  52 #include "dos_commanderrors.h"
  53
  54 #include <aros/shcommands.h>
  55
  56 AROS_SH1(Quit, 41.1,
  57 AROS_SHA(LONG *, ,RC,/N,NULL))
  58 {
  59     AROS_SHCOMMAND_INIT
  60
  61     struct CommandLineInterface *cli = Cli();
  62     int retval = RETURN_OK;
  63
  64
  65     if(cli && !cli->cli_Interactive)
  66     {
  67         struct FileHandle *fh = BADDR(cli->cli_CurrentInput);
  68
  69         fh->fh_Pos = fh->fh_End + 1; /* Simulate an EOF */
  70
  71         if(SHArg(RC) != NULL)
  72             retval = (int)*SHArg(RC);
  73
  74     }
  75     else
  76     {
  77         PrintFault(ERROR_SCRIPT_ONLY, "Quit");
  78         retval = RETURN_FAIL;
  79     }
  80
  81     return retval;
  82
  83     AROS_SHCOMMAND_EXIT
  84 }