Brief Index      Full Index      I.M. Reference

Begin_Callback_Name_Search


Functions

void Begin_Callback_Name_Search (void)
void Show_Callback_Name_Count (int *count)
HC_BOOLEAN Find_Callback_Name (char *name)
void End_Callback_Name_Search (void)

Function Documentation

void Begin_Callback_Name_Search ( void   ) 

Finds the names of all previously defined callback routines.

DETAILS

These routines are used to find all the callback name definitions existing within the database. For example,

		Begin_Callback_Name_Search ()
		while (Find_Callback_Name (name))
			print (name)
		End_Callback_Name_Search ()

prints all the known callback definitions. Begin_Callback_Name_Search() initiates the search for callback name definitions. If you need to know how many callback definitions will be returned (possibly to allocate a sufficiently large data structure to hold the results), call Show_Callback_Name_Count() after initiating the search.

Find_Callback_Name() returns the names, one by one. This function returns false when all the definitions have been returned.

End_Callback_Name_Search() terminates the search. This last step can be done anytime after initiating the search.

NOTES

If a callback search is in progress and a callback becomes undefined (via UnDefine_Callback_Name() ), it will not be returned by subsequent calls to Find_Callback_Name() . If a callback definition is added, it will not be returned until the next callback search is initiated.

Show_Callback_Name_Count() is only valid between Begin_Callback_Name_Search() and End_Callback_Name_Search() . It will always return the total number of callback names, not the remaining number of definitions.

Callback name searches can be nested. A user program can call Begin_Callback_Name_Search() and look at the defined callbacks without interfering with a callback search, which might be in progress. When End_Callback_Name_Search() is called, the previously active callback search is resumed.

RESTRICTIONS

See also:
Define_Callback_Name, Show_Callback_Name.

void Show_Callback_Name_Count ( int *  count  ) 

Finds out how many callback names will be returned. This is useful for determining the size of a data structure needed to store incoming items.

Parameters:
count - The total number of callback names returned by Find_Callback_Name() . Returned to user. Passed by reference always.

DETAILS

No additional details. See Begin_Callback_Name_Search()

HC_BOOLEAN Find_Callback_Name ( char *  name  ) 

Retrieves the callback names, one at a time. The function returns false when all aliases have been returned.

Parameters:
name - Name of callback routine found in the system's list.
Returns:
flag

DETAILS

No additional details. See Begin_Callback_Name_Search()

void End_Callback_Name_Search ( void   ) 

Terminates the callback name search sequence and frees any involved memory.

DETAILS

No additional details. See Begin_Callback_Name_Search()

Main Index
Brief Index      Full Index      I.M. Functions