api_remove_state
List of: Functions
Subjects: History and Roll
Contents: Kernel

Action: Merges a DELTA_STATE instance into a HISTORY_STREAM.

Prototype: outcome api_remove_state (


DELTA_STATE* ds // state to remove


);

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 API removes a DELTA_STATE from its owning HISTORY_STREAM without deleting it. This is used to in conjunction with api_note_state and api_remove_state to build multiple independent history streams. After noting a state, it can be moved to an alternate stream by removing it from the default stream, and adding it using api_add_state. To the stream it is to become a part of.

Library: kernel

Filename: kern/kernel/kernapi/api/kernapi.hxx

Effect: Read-only
PDF/KERN/16FNA.PDF
HTM/DATA/KERN/KERN/16FNA/0125.HTM