Action:
|
If necessary, adds an empty delta state to the beginning of the history stream so that users can roll to a state with no entities.
|
|
Prototype:
|
outcome api_ensure_empty_root_state (
|
|
|
HISTORY_STREAM* history,
|
// history stream to be
|
|
|
|
|
// modified
|
|
|
DELTA_STATE*& root_state
|
// pointer to the (empty)
|
|
|
|
|
// root delta state
|
|
|
);
|
|
Includes:
|
#include "kernel/acis.hxx"
|
|
#include "kernel/kernapi/api/api.hxx"
|
|
#include "kernel/kernapi/api/kernapi.hxx"
|
|
#include "kernel/kerndata/bulletin/bulletin.hxx"
|
|
Description:
|
This routine examines the root delta state of the specified history stream. If the root state is empty (no bulletin boards), then it does nothing. If the root state is non-empty, then it adds a new, empty, root state immediately "before" the original root state. In either case, it returns (through the root_state argument) a pointer to the resulting empty root state.
|
|
Library:
|
kernel
|
|
Filename:
|
kern/kernel/kernapi/api/kernapi.hxx
|
|
Effect:
|
Changes model
|