workbench/libs/locale/getlocalestr.c

   1 /*
   2     Copyright © 1995-2011, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: GetLocaleStr() - Get a built-in system string.
   6     Lang: english
   7 */
   8
   9 #include <exec/types.h>
  10 #include <proto/exec.h>
  11 #include "locale_intern.h"
  12 #include <aros/asmcall.h>
  13
  14 /*****************************************************************************
  15
  16     NAME */
  17 #include <proto/locale.h>
  18
  19         AROS_LH2(CONST_STRPTR, GetLocaleStr,
  20
  21 /*  SYNOPSIS */
  22         AROS_LHA(const struct Locale *, locale, A0),
  23         AROS_LHA(ULONG, stringNum, D0),
  24
  25 /*  LOCATION */
  26         struct LocaleBase *, LocaleBase, 13, Locale)
  27
  28 /*  FUNCTION
  29         This function will return a system standard string from
  30         the current Locale.
  31
  32     INPUTS
  33         locale      - The current locale.
  34         stringNum   - The number of the string to get a pointer to.
  35                       See the include file <libraries/locale.h>
  36                       for a list of possible values.
  37
  38     RESULT
  39         A pointer to a NULL-terminated string, or NULL if the string
  40         requested was unknown. The returned string is READ-ONLY and
  41         is valid only as long as the Locale remains open.
  42
  43     NOTES
  44
  45     EXAMPLE
  46
  47     BUGS
  48
  49     SEE ALSO
  50
  51     INTERNALS
  52
  53 *****************************************************************************/
  54 {
  55     AROS_LIBFUNC_INIT
  56
  57 #ifdef AROS_CALL1
  58     return AROS_CALL1(CONST_STRPTR, IntL(locale)->il_LanguageFunctions[3],
  59         AROS_LCA(ULONG, stringNum, D0), struct LocaleBase *, LocaleBase);
  60 #else
  61     return AROS_UFC2(CONST_STRPTR, IntL(locale)->il_LanguageFunctions[3],
  62         AROS_UFCA(ULONG, stringNum, D0),
  63         AROS_UFCA(struct LocaleBase *, LocaleBase, A6));
  64 #endif
  65
  66     AROS_LIBFUNC_EXIT
  67 }