AST_MAPGETC

Get a scalar or vector value from a KeyMap as a single string

Description:

This function gets a named value from a KeyMap as a single string. For scalar values it is equivalent to AST_MAPGET0C. If the value is a vector, the returned string is a comma-separated list of the vector elements, enclosed in parentheses.

Invocation

RESULT = AST_MAPGETC( THIS, KEY, VALUE, L, STATUS )

Arguments

THIS = INTEGER (Given)
Pointer to the KeyMap.
KEY = CHARACTER ∗ ( ∗ ) (Given)
The character string identifying the value to be retrieved. Trailing spaces are ignored. The supplied string is converted to upper case before use if the KeyCase attribute is currently set to zero.
VALUE = CHARACTER ∗ ( ∗ ) (Returned)
The requested value. If the requested key is not found, or if it is found but has an undefined value (see AST_MAPPUTU), then the contents of the supplied string are unchanged on exit.
L = INTEGER (Returned)
This parameter is only present in the interface for the AST_MAPGET0C function. It is returned holding the number of characters written into the CHARACTER variable supplied for parameter VALUE.
STATUS = INTEGER (Given and Returned)
The global status.

Returned Value

AST_MAPGETC = LOGICAL
.TRUE. is returned if the requested key name was found, and does not have an undefined value (see AST_MAPPUTU). .FALSE. is returned otherwise.

Notes:

Copyright (C) 2021 East Asian Observatory