astMapLenCastMapLenC
-
Get the number of characters in a character entry in a KeyMap
- Description:
- This function returns the minimum length which a character variable
which must have in order to be able to store a specified entry in
the supplied KeyMapKeyMap. If the named entry is a vector entry, then the
returned value is the length of the longest element of the vector
value.
- Synopsis:
- int astMapLenC( AstKeyMap
this, const char
key )
- Parameters:
-
this
-
Pointer to the KeyMap.
-
key
-
The character string identifying the KeyMap entry. Trailing
spaces are ignored.
The supplied string is converted to upper case before use if the
KeyCaseKeyCase attribute is currently set to zero.
- Returned Value:
-
astMapLenC()
-
The length (i.e. number of characters) of the longest formatted
value associated with the named entry.
This does not include the trailing null character.
- Notes:
- A function value of zero will be returned without error if the
named entry cannot be formatted as a character string.
- A function value of zero will be returned if an error has already
occurred, or if this function should fail for any reason.