|
Action:
|
Restores an history stream and associated entities and entity id information from a file.
|
|
|
Prototype:
|
outcome api_restore_history_file (
|
|
|
FileInterface* file_ptr,
|
// open file descriptor
|
|
|
HISTORY_STREAM_LIST& hlist,// restored history
|
|
|
|
|
// streams
|
|
|
logical create_new_hs
|
// flag for creating
|
|
|
|
= FALSE,
|
// new history stream
|
|
|
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.
|
|
|
If
create_new_hs is set
TRUE and the restored file has no history, this function will create a new history stream.
|
|
|
Errors:
|
Warning: Version number of this system differs from version that made the save file being read.
|
|
|
|
Warning: Record for unrecognized entity is being skipped. Unable to read file. Malformed save file.
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/kernapi.hxx
|
|
|
Effect:
|
Changes model
|