|
Action:
|
Deletes the
HISTORY_STREAM and all
ENTITYs in the stream.
|
|
|
Prototype:
|
outcome api_delete_history (
|
|
|
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:
|
Deletes the
HISTORY_STREAM and all
ENTITYs associated with
BULLETIN on the
HISTORY_STREAM. Therefore, no
ENTITYs will be deleted when logging is off. Uses the default
HISTORY_STREAM if none is supplied.
|
|
|
Errors:
|
Fails when unable to remove all
ENTITYs referred to in the stream.
|
|
|
Limitations:
|
Logging must be used.
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/kernapi.hxx
|
|
|
Effect:
|
System routine
|