Progress
Language Reference
GET-KEY-VALUE Statement
Searches the current environment for a particular key and places its value into a particular data item.
Environments typically consist of sections, each of which can contain keys, each of which consists of a name and a value. A typical section name is COLORS. A typical key within this section consists of the name “COLOR16" and the value 255,255,0. This key attaches this particular name to this particular color. (The value represents a color specification using the red-green-blue color-naming scheme.)
The current environment might be the registry or an initialization file. The registry consists of sections called keys and subkeys arranged in a hierarchy. Keys and subkeys contain value entries, each of which consists of a value name and value data. Initialization files, by contrast, consist of a single level of sections. Sections contain entries, each of which consists of a name, an equals sign (=), and a value.
For more information on environments, see the chapter on colors and fonts in the Progress Programming Handbook .
SYNTAX
section-name
A CHARACTER expression that specifies the name of the section that contains the key of interest.
In initialization files, section names appear in square brackets([]). When you specify a section name in the GET-KEY-VALUE statement, omit the square brackets.
key-name
A CHARACTER expression that specifies the name of the key of interest.
If you specify the unknown value (?) or the empty string (""), GET-KEY-VALUE returns a comma-separated list of all keys in the section you specified.
DEFAULT
Tells GET-KEY-VALUE to use the default key of section section-name.
Some applications store data in the registry under the default key of a section. This option lets you retrieve this data. For an example, see the EXAMPLES section of this entry.
This option applies only to the registry and not to initialization files.
key-value
The name of a CHARACTER variable to hold the value of the key of interest.
EXAMPLESIf the current environment resides in the registry, the following example:
If the current environment resides in an initialization file, the following example:
If the current environment is the registry, the following example:
If the current environment resides in an initialization file, the following example returns a comma-separated list of all section names in the initialization file.
If the current environment resides in the registry, the following examples:
If the current environment resides in an initialization file, the following examples:
If the current environment resides in the registry, the following examples return a comma-separated list of subkeys under the current environment location and all value names directly under the current environment location. The delimiter @value@ separates the subkey names from the value names.
If the current environment resides in an initialization file, the following examples return a comma-separated list of all section names in the initialization file.
If the current environment resides in the registry, the following example:
If the current environment resides in an initialization file, the following example returns an error.
NOTES
- The current environment is either the default environment, the startup environment (an environment that a startup parameter specified), or an application environment that the LOAD Statement loaded and that the USE Statement made current.
- If you unload the current environment (using the UNLOAD Statement) and then use the GET-KEY-VALUE statement, you access the startup environment.
SEE ALSO
LOAD Statement, PUT-KEY-VALUE Statement, UNLOAD Statement, USE Statement
Copyright © 2004 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095 |