tpm_cleanactionlistgetat

Land Desktop Development ARX CPP SDK

Up a level
tpm_cleanactionlistgetat
 
 

Gets the cleanup action at a given list position.

int

*tpm_cleanactionlistgetat

ade_id clean_var_id,

long index,

ade_id action_var_id);

Returns a cleanup action as a clean group type. See tpm_cleangrouptype for a list of types.

clean_var_id The cleanup variables ID returned by tpm_varalloc.
index The list position to access.
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. A value greater than or equal to the list size or less than 0 returns an error.

The action_var_id argument references properties affecting the specific cleanup action that you are getting (see Cleanup Action Variables). Use tpm_varget or tpm_varlist to read them after calling tpm_cleanactionlistgetat.