PK_MARK_goto_2

PK_ERROR_code_t         PK_MARK_goto_2
(
--- received arguments ---
PK_MARK_t               mark,          --- mark to go to
const PK_MARK_goto_o_t *options,       --- options structure

--- returned arguments ---
PK_MARK_goto_r_t *const results        --- results
)


This function returns the modeller to the state when the given mark was
created.


Specific Errors:
    PK_ERROR_rollback_not_started   (MILD) Neither PK nor partitioned rollback
                                           active
    PK_ERROR_bad_mark               (MILD) The given mark is invalid
    PK_ERROR_frustrum_failure       (MILD or FATAL)
                                           The frustrum returned an error
    PK_ERROR_bad_combination        (MILD) PK rollback has been started with
                                           PK_MARK_start and 'no_roll_diff' is
                                           not PK_ATTRIB_no_roll_diff_ignore_c


If it is not possible to rollback, the function raises an error, and
leaves the model unchanged, except that in the case of partitioned rollback,
some partitions may have been rolled. If the failure is due to a 'disk full'
error from the frustrum, the application could make more space available
and retry the operation.

In the case of partitioned rollback, the following interface parameters will
be unaffected. Other interface parameters will be rolled back.

    Interface checking on/off
    Journalling on/off
    Roll forward on/off
    Tag limit

A thread that has locked partitions can only roll to marks created in that
thread since its partitions were locked. While there are locked partitions,
threads that do not have locked partitions may not roll to any marks that
were created before those partitions were locked.

If roll forward is off, then all forward marks become invalidated.

This function should only be called when PK rollback has been started
with PK_MARK_start or partitioned rollback has been started with
PK_DELTA_register_callbacks.

The return structure is currently unused but is included for future
developments.