astMapKey

Get the key at a given index within the KeyMap

Description:

This function returns a string holding the key for the entry with the given index within the KeyMap.

This function is intended primarily as a means of iterating round all the elements in a KeyMap. For this purpose, the number of entries in the KeyMap should first be found using astMapSize and this function should then be called in a loop, with the index value going from zero to one less than the size of the KeyMap. The index associated with a given entry is determined by the SortBy attribute.

Synopsis

const char astMapKey( AstKeyMap this, int index )

Parameters:

this
Pointer to the KeyMap.
index
The index into the KeyMap. The first entry has index zero, and the last has index " size-1" , where " size" is the value returned by the astMapSize function.

Returned Value

astMapKey()
A pointer to a null-terminated string containing the key.

Notes: