|
Action:
|
Writes a history stream and associated entities and entity id information to a file.
|
|
|
Prototype:
|
outcome api_save_history_file (
|
|
|
FileInterface* file_ptr,
|
// open file descriptor
|
|
|
HISTORY_STREAM* hs
|
// stream to save
|
|
|
|
= NULL,
|
|
|
logical active_ents_only
|
// TRUE to ignore roll
|
|
|
|
= FALSE,
|
// information
|
|
|
logical mainline_only
|
// TRUE to ignore rolled
|
|
|
|
= FALSE,
|
// delta states
|
|
|
AcisOptions* ao = NULL
|
// acis options
|
|
|
);
|
|
|
Includes:
|
#include "kernel/acis.hxx"
|
|
#include "baseutil/logical.h"
|
|
#include "kernel/kernapi/api/api.hxx"
|
|
#include "kernel/kernapi/api/kernapi.hxx"
|
|
#include "kernel/kerndata/bulletin/bulletin.hxx"
|
|
#include "kernel/kernutil/fileio/fileif.hxx"
|
|
#include "kernel/kernapi/api/acis_options.hxx"
|
|
|
Description:
|
This routine is equivalent to
api_save_history, taking a
FileInterface* rather than a
FILE*. Please refer to the description of that routine.
|
|
|
Errors:
|
Failed to save entities; e.g., unable to write disk file.
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/kernapi.hxx
|
|
|
Effect:
|
Read-only
|