Name
hw_GetCatalogString -- get string from catalog (V9.0)
Synopsis
STRPTR str = hw_GetCatalogString(APTR handle, int idx, STRPTR def,
                 struct hwTagList *tags);
Library
locale

Function
This returns the string at the catalog index specified by idx from the catalog specified by handle. If handle is NULL or if the catalog doesn't have a string at the specified index, def will be returned. Thus, it is guaranteed that hw_GetCatalogString() never returns NULL.

The handle you pass as the first parameter must have been allocated by hw_OpenCatalog(). See hw_OpenCatalog for details. Alternatively, it can also be NULL.

Designer compatibility
Supported since Designer 6.0

Inputs
handle
valid catalog handle or NULL
idx
index of catalog string to return
def
default return value if handle is NULL or index doesn't exist
tags
reserved for future use; pass NULL
Results
str
catalog string at the specified index
Show TOC