api_get_file_info
List of: Functions
Subjects: SAT Save and Restore
Contents: Kernel

Action: Gets header info from the last restored file.

Prototype: outcome api_get_file_info (


FileInfo& info // file information




// returned


);

Includes: #include "kernel/acis.hxx"

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

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

#include "kernel/kerndata/savres/fileinfo.hxx"

Description: The API fills in a FileInfo class with the header information from the last restored file. It does not alter the model.


The FileInfo class contains the following information:


product_id is a string indicating the product and version which produced the save file.


date is a string indicating the date the model was saved (e.g., "Fri Feb 9 16:49:43 MST 1996").


units is a double indicating the modeling units.


acis_version is a string indicating the version of the ACIS libraries used in the product which produced the save file.


file_version is the ACIS save file version for which the model was saved (e.g., 200).


SPAresabs is the distance tolerance in effect when the model was saved.


SPAresnor is the normal tolerance in effect when the model was saved.


For consistency, the recommended values for units are:


"mm" = Millimeters

"cm" = Centimeters

"M" = Meters

"KM" = Kilometers

"um" = Microns

"In" = Inches

"M" = Meters

"Ft" = Feet

"Mi" = Miles

"mil" = Mils

Library: kernel

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

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