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

Action: Sets required header info to be written to ACIS save files.

Prototype: outcome api_set_file_info (


unsigned long, // mask indicating fields




// to set


FileInfo const& info // info to be set


);

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 sets the information to be written to the header of later saved files. Does not alter the model. Beginning with ACIS release 6.3, it is required that the product ID and units be populated for the file header before you can save a SAT file.


The mask value indicates which values in the supplied FileInfo structure are to be set. It is composed by ORing together mask values as indicated below.


The FileInfo structure contains the following fields which can be set:


product_id Mask = FileId

String indicating the product and version that produced the save file.

units Mask = FileUnits

Modeling units specified as millimeters per unit.

units values for common modeling units are:


-1.0 = Units not specified

1.0 = Millimeters

10.0 = Centimeters

1000.0 = Meters

1000000.0 = Kilometers

25.4 = Inches

304.8 = Feet

914.4 = Yards

1609344.0 = Miles

Library: kernel

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

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