PK_PMARK_goto_2

PK_ERROR_code_t          PK_PMARK_goto_2
(
--- received arguments ---
PK_PMARK_t               pmark,         --- pmark to go to
const PK_PMARK_goto_o_t *options,       --- options structure

--- returned arguments ---
int               *const n_new,         --- number of entities created
PK_ENTITY_t      **const new_entities,  --- entities created
int               *const n_mod,         --- number of entities modified
PK_ENTITY_t      **const mod_entities,  --- entities modified
int               *const n_del,         --- number of entities deleted
int              **const del_entities   --- entities deleted
)


This function returns the partition to the state when the given pmark was
created.


Specific Errors:
    PK_ERROR_rollback_not_started   (MILD) Partitioned rollback is not active
    PK_ERROR_bad_mark               (MILD) The given pmark may not be rolled to
    PK_ERROR_bb_not_empty           (MILD) The bulletin board is on and not
                                    empty
    PK_ERROR_frustrum_failure       (potentially FATAL) The frustrum returned
                                    an error
    PK_ERROR_facet_geometry         (MILD) The partition contains facet
                                    geometry at the given pmark, but facet
                                    geometry is not enabled.
    PK_ERROR_lattice_geometry       (MILD) The partition contains lattice(s)
                                    at the given pmark, but facet geometry is
                                    not enabled.


If it is not possible to rollback, the function raises an error. The modeller
state may have changed in that the partition may have been rolled part way to
the given pmark, but if so, it will be 'at' some other pmark. If the failure
is due to a 'disk full' error from the Frustrum, the roll operation may be
retried after making more disk space available.

The current partition may not be rolled back to its initial pmark.

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.

Further rollback tracking controls can be specified in 'options'.

The 'mod_entities' list is generated using internal data structure changes.  It
is not recommended for this list to be used in application tracking for the
following reasons:

    o Some changes (as perceived by the application) may not be present in the
      list.
    o Although all changed attributes ARE included in the list, some additional
      entries may also be present.

For more information, see Rolling to a partition mark in the
Functional Description.