get_global_atom_name


templaet <class character>
unsigned get_global_atom_name(atom atom_to_get,
                              character* buffer,
                              int size)

This function queries the string associated with an atom in the global atom table.

Parameters

atom atom_to_get

The global atom whose associated string is being queried.

character* buffer

A pointer to a buffer to hold the associated string.

int size

The size of the buffer pointed to by the previous parameter.

Return

unsigned

Zero is returned when an error occurs; otherwise, the length of the string copied to the buffer (not including the terminating null character) is returned.

Notes

For an integer atom, the first character of the returned string is the hash character (#) and the remaining characters of the string are the decimal digits of the integer value.