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

Action: Returns the active DELTA_STATE in the given HISTORY_STREAM.

Prototype: outcome api_get_active_state (


DELTA_STATE*& active_ds, // returned delta state


HISTORY_STREAM* hs // input history stream



= NULL


);

Includes: #include "kernel/acis.hxx"

#include "kernel/kernapi/api/api.hxx"

#include "kernel/kernapi/api/kernapi.hxx"

#include "kernel/kerndata/bulletin/bulletin.hxx"

Description: Returns the active DELTA_STATE in the given HISTORY_STREAM. The active DELTA_STATE is either the most recently closed state in the stream, made by calling note_state, or the state just rolled to. If no HISTORY_STREAM is supplied, the default stream is used.

Library: kernel

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

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