|
Action:
|
Removes delta states from a history stream.
|
|
|
Prototype:
|
outcome api_prune_history (
|
|
|
HISTORY_STREAM* hs,
|
// history stream to
|
|
|
|
|
// prune
|
|
|
DELTA_STATE* ds
|
// delta state at
|
|
|
|
= NULL
|
// boundary of pruning
|
|
|
|
|
// returned
|
|
|
);
|
|
|
Includes:
|
#include "kernel/acis.hxx"
|
|
#include "kernel/kernapi/api/api.hxx"
|
|
#include "kernel/kernapi/api/kernapi.hxx"
|
|
#include "kernel/kerndata/bulletin/bulletin.hxx"
|
|
|
Description:
|
Snips the graph of
DELTA_STATEs just before the given state and deletes the piece of the graph that does not include the active state. Thus one can prune forward branches by passing a state after the current state. One can prune past history by passing a state prior to the current state. It is impossible to prune away the active state.
|
|
|
Errors:
|
The pointer to ds or hs is
NULL.
|
|
The given delta state is not in the given history stream.
|
|
|
Limitations:
|
The number of places that the two laws equal must be finite.
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/kernapi.hxx
|
|
|
Effect:
|
Read-only
|