tpm_cleanstart

Land Desktop Development ARX CPP SDK

Up a level
tpm_cleanstart
 
 

Starts the cleanup process.

int

tpm_cleanstart(

ade_id clean_id);

Returns RTNORM or an error code.

clean_id The cleanup model ID returned by tpm_cleanalloc.

The function finds the first group type or subtype that contains errors. See tpm_cleangrouptype and tpm_cleangroupsubtype for lists of types.

Cleanup is an iterative process. Depending on cleanup options and processing order, you may need to run the cleanup loop several times to achieve the desired results. After selecting the groups to process with tpm_cleangrouptype and processing all the groups in the selection set, call tpm_cleancomplete to test if cleaning is complete. If complete, call tpm_cleanstart and repeat the cleanup loop.

For an example of the cleanup process, see tpm_cleanalloc.