The features described in this topic are obsolete
and should not be used in new IDL code.

MSG_CAT_OPEN

The MSG_CAT_OPEN function opens a specified catalog object file.

Syntax

Result = MSG_CAT_OPEN( application [, DEFAULT_FILENAME=filename] [, FILENAME=string] [, FOUND=variable] [, LOCALE=string] [, PATH=string] [, SUB_QUERY=value] )

Return Value

Returns a catalog object for the given parameters if found. If a match is not found, an unset catalog object is returned. If unset, the IDLffLanguageCat::Query method will always return the empty string unless a default catalog is provided.

Arguments

application

A scalar string representing the name of the desired application's catalog file.

Keywords

DEFAULT_FILENAME

Set this keyword to a scalar string containing the full path and filename of the catalog file to open if the initial request was not found.

FILENAME

Set this keyword to a scalar string containing the full path and filename of the catalog file to open. If this keyword is set, application, PATH and LOCALE are ignored.

FOUND

Set this keyword to a named variable that will contain 1 if a catalog file was found, 0 otherwise.

LOCALE

Set this keyword to the desired locale for the catalog file. If not set, the current locale is used.

PATH

Set this keyword to a scalar string containing the path to search for language catalog files. The default is the current directory.

SUB_QUERY

Set this keyword equal to the value of the SUB_QUERY key to search against. If a match is found, it is used to further sub-set the possible return catalog choices.

Version History

Introduced: 5.2.1