HC_Begin_Callback_Name_Search
-
void
HC_Begin_Callback_Name_Search(void) - void HC_Begin_Callback_Name_Search(void)
Finds the names of all previously defined callback routines.
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.
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.
HC_Define_Callback_Name, HC_Show_Callback_Name.