Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


  >  Docs Center  >  IDL Reference  >  Language Catalogs  >  IDLffLangCat::Query

IDLffLangCat::Query

IDLffLangCat::Query

Syntax | Return Value | Arguments | Keywords | Version History

The IDLffLangCat::Query function method returns the string or string array that corresponds to all supplied key values.

Syntax


Result = Obj->[IDLffLangCat::]Query( Key [, DEFAULT_STRING=string] )

Return Value


Returns a string or string array that corresponds to all supplied key values. If no key can be found, then the default string or, if no default string is supplied, an empty string is returned.

Arguments


Key

A string or string array used as the key or keys against which the query is performed. If a given key does not exist in the current language, the default language is queried (if one exists).

Keywords


DEFAULT_STRING

Set this keyword to a string or string array to be used if the key is not found in the catalog. If a scalar string is supplied, it will be returned for all keys not found. For example, if DEFAULT_STRING is “Key not found,” this string is returned for each failed query on a key or keys. If a string array is supplied, only those values whose indices match the missing keys will be returned. That is, you can have different default strings for different cases of failed query matches (e.g., “No File key found” and “No Tools key found” returned, respectively, for failed queries on keys associated with a File menu and a Tools menu).

Version History


6.1

Introduced



© 2018 Harris Geospatial Solutions, Inc. |  Privacy Policy
My Account    |    Store    |    Contact Us