Home / Autodocs / locale.library
NAME
- GetCatalogStr
-
get a string from a message catalog. (V38)
SYNOPSIS
string = GetCatalogStr(catalog,stringNum,defaultString);
D0 A0 D0 A1
STRPTR GetCatalogStr(struct Catalog *,LONG,STRPTR);
D0 A0 D0 A1
STRPTR GetCatalogStr(struct Catalog *,LONG,STRPTR);
FUNCTION
This function returns a specific string within a message catalog. If the catalog parameter is NULL, or the requested message does not exist, then defaultString is returned.
INPUTS
- catalog
-
a message catalog as obtained from OpenCatalog(), or NULL
- stringNum
-
a message number within the catalog
- defaultString
-
string to return in case "catalog" is NULL or "stringNum" can't be found
RESULT
- string
-
a pointer to a NULL-terminated string. The returned string is READ-ONLY, do NOT modify! This string pointer is valid only as long as the catalog remains open.
BUGS
In locale.library V38-V40 the GetCatalogStr() function would preserve the value of register A1 and also return the result string both in registers A0 and D0. These are side-effects which, however, some applications depend upon. You are well-advised to only use the result string returned in register D0 and to assume that registers A0, A1 and D1 will contain indeterminate data.