Utility Functions : List of Utility Functions : stm_list_purge

stm_list_purge
Erases the input lis pointers and the list elements.
Note:  
This function is intended for use only with lists of strings. You should not purge a list of Rational Statemate elements (IDs) because it can cause serious problems in your program. (Compare with stm_list_destroy.)
The returned value is false when the input list is a nil list.
After the function operation, list cannot be used as an input argument in list functions.
Function Type
int
Syntax
stm_list_purge (list, &status)
Arguments
Input/Output
Status Codes
Example
To deallocate the space associated with the list of names name_list (and the strings included in this list are not referenced by other pointers in your program), use the following statements:

.
.
list = stm_r_st_attr_name (st_id, &status);
if (stm_list_purge (list, &status))
printf ("list purged");
.
.