PK_DEBUG_SESSION_check

PK_ERROR_code_t                   PK_DEBUG_SESSION_check
(
--- received arguments ---
const PK_DEBUG_SESSION_check_o_t *options,   --- options structure

--- returned arguments ---
int                        *const n_faults,  --- number of faults
PK_DEBUG_check_fault_t    **const faults     --- faults
)


This function checks the session and a given list of partitions.


Specific Errors:
    PK_ERROR_check_error            a fault has been found when max_faults = 0
    PK_ERROR_rollback_not_started   Partitioned rollback is not active
    PK_ERROR_bb_not_empty           The bulletin board is on and not empty
    PK_ERROR_frustrum_failure       (potentially FATAL) The frustrum returned
                                    an error



This function performs a set of checks on the session and the list of
partitions specified in the options structure and returns information
about the faults found if any. If no partitions are specified then all
partitions are checked.

An array of up to 'max_faults' (specified in the options structure)
check fault structures is returned. If 'max_faults' is zero and a
fault is found, the function will return a PK error:
PK_ERROR_check_error.

Functions called from within any Parasolid callback function will not
be watched.

See here for more information on this function.

NOTE: This function is only to be used for debugging purposes.