tpm_cleanactionlistins

Land Desktop Development ARX CPP SDK

Up a level
tpm_cleanactionlistins
 
 

Inserts a cleanup action in the action list.

int

tpm_cleanactionlistins

ade_id clean_var_id,

long index,

int action,

ade_id action_var_id);

Returns RTNORM or an error code.

clean_var_id The cleanup variables ID returned by tpm_varalloc.
index Where to insert in the action list.
action The cleanup action to insert, a clean group type. See tpm_cleangrouptype for a list of types.
action_var_id The cleanup action variables ID returned by tpm_varalloc.

The clean_var_id argument references properties for the cleanup operation that you are preparing to initiate (see Cleanup Variables). These properties include the action list.

The index argument is a zero-based position in the action list, or -1 for the last position. A value greater than or equal to the list size or less than -1 is taken as -1.

Note  When you insert the Simplify Objects action (clean group type 128), it is always listed first, and you cannot insert it more than once.

The action_var_id argument references properties affecting the specific cleanup action that you are inserting (see Cleanup Action Variables). Use tpm_varset to set them before calling tpm_cleanactionlistins.