compiler/alib/opencatalog.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Varargs version of OpenCatalog()
   6     Lang: english
   7 */
   8
   9 #define AROS_TAGRETURNTYPE  struct Catalog *
  10 #include <utility/tagitem.h>
  11
  12
  13 /*****************************************************************************
  14
  15     NAME */
  16 #include <libraries/locale.h>
  17 #include <proto/locale.h>
  18 extern struct LocaleBase *LocaleBase;
  19 #undef OpenCatalog /* Get rid of the macro from inline/ */
  20
  21         struct Catalog * OpenCatalog (
  22
  23 /*  SYNOPSIS */
  24         struct Locale * locale,
  25         STRPTR          name,
  26         Tag             tag1,
  27         ...             )
  28
  29 /*  FUNCTION
  30         This is the varargs version of the locale.library OpenCatalogA().
  31         For information see locale.library/OpenCatalog()
  32
  33     INPUTS
  34         locale      -   The locale describing the language the users
  35                         wants.
  36         name        -   Name of the catalog file.
  37         tag1        -   TagList of extra arguments.
  38
  39     RESULT
  40         Either a pointer to a Catalog, or NULL.
  41
  42         Although the function may have returned NULL, that does not
  43         necessarily meant there is an error. If dos/IoErr() returns
  44         0, then there was no error, but the language of the built in
  45         strings is the same as that of a catalog.
  46
  47         If IoErr() != 0, then there was an error however.
  48
  49     NOTES
  50
  51     EXAMPLE
  52
  53     BUGS
  54
  55     SEE ALSO
  56         locale/OpenCatalogA(), locale/CloseCatalog(),
  57         locale/GetCatalogStr()
  58
  59     INTERNALS
  60
  61     HISTORY
  62         15-02-1997  iaint   Wrote.
  63
  64 *****************************************************************************/
  65 {
  66     AROS_SLOWSTACKTAGS_PRE(tag1)
  67
  68     retval = OpenCatalogA(locale, name, AROS_SLOWSTACKTAGS_ARG(tag1));
  69
  70     AROS_SLOWSTACKTAGS_POST
  71 } /* OpenCatalog */