PK_PMARK_goto

PK_ERROR_code_t     PK_PMARK_goto
(
--- received arguments ---
PK_PMARK_t          pmark,          --- pmark to go to

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


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

NOTE: This function is deprecated and has been superseded by PK_PMARK_goto_2.



Specific Errors:
    PK_ERROR_rollback_not_started   Partitioned rollback is not active
    PK_ERROR_bad_mark               The given pmark may not be rolled to
    PK_ERROR_bb_not_empty           The bulletin board is on and not empty
    PK_ERROR_frustrum_failure       (potentially FATAL) The frustrum returned
                                    an error


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.

The output arrays 'new_entities', 'mod_entities' and 'del_entities' are
optional. If they are set to NULL, the function will only compute the numbers
of entities created, modified or deleted by the roll operation.

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

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.