PK_PARTITION_delete

PK_ERROR_code_t                PK_PARTITION_delete
(
--- received arguments ---
PK_PARTITION_t                 partition,   --- partition
const PK_PARTITION_delete_o_t *options      --- deletion options
)


This function deletes the given 'partition' and all data within it.


Specific Errors:
    PK_ERROR_rollback_not_started   Partitioned rollback is not active (MILD)
    PK_ERROR_partition_is_current   Partition is the current partition (MILD)
    PK_ERROR_bad_mark               Cannot make current partition current at
                                    mark (MILD)
    PK_ERROR_partition_not_empty    Partition is not empty or might not be
                                    empty at a session mark (MILD)
    PK_ERROR_bb_not_empty           The bulletin board is on and not empty
                                    (MILD)
    PK_ERROR_frustrum_failure       The frustrum returned an error (MILD)


The pmarks of the 'partition' are removed from any marks that 'use' them. The
'partition', its pmarks and all model data it contains at every pmark is
irreversibly deleted. The function may temporarily require more disk space. If
the failure is due to a 'disk full' error from the Frustrum, the delete
operation may be retried after making more disk space available.

Partitions that are not empty or partitions that might not be empty at a
session mark may not be deleted unless this restriction is overridden in
'options'. Empty partitions contain no assemblies, bodies, geometric entities,
KI lists or transforms. To ensure the 'partition' is also empty at all session
marks, each mark should either 'use' the initial pmark or the pmark that the
'partition' is currently at.

The current partition cannot be deleted. If the 'partition' was current at any
session marks, the current partition will become current at these marks. To
ensure this, at every session mark where the current partition is at its
initial pmark, the 'partition' must also be at its initial pmark, i.e. the
marks that 'use' the initial pmark of the current partition must also 'use'
the initial pmark of the given 'partition'. This condition can be tested using
the information returned from PK_PMARK_ask_marks.

This function may not be called if the bulletin board is switched on and is
not empty.

This function should only be called when partitioned rollback has been started
by calling PK_DELTA_register_callbacks.