tpm_cleaninitanchorset

Land Desktop Development ARX CPP SDK

Up a level
tpm_cleaninitanchorset
 
 

Specifies anchored entities for the cleanup model.

int

tpm_cleaninitanchorset

ade_id clean_id,

ade_id clean_var_id,

ads_name ssAnchor);

Returns RTNORM or an error code.

clean_id The cleanup model ID returned by tpm_cleanalloc.
clean_var_id The cleanup variables ID returned by tpm_varalloc.
ssanchor The entities to be anchored (a selection set).

Anchored entities remain fixed in position during the cleanup process. You can free the selection set after anchored entities have been specified.

Call tpm_cleaninitanchorset before calling tpm_cleaninit.

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

If the cleanup variable ANCHOROBJS_LAYERS is set to "*" (all layers), all ssAnchor entities will be anchored. If it contains a list of layers, ssAnchor entities will be anchored only if they reside on those layers.