All Frameworks  Class Hierarchy  This Framework  Indexes

SPAkern Global Function api_set_file_info

outcome api_set_file_info(	unsigned long	`mask`,
	const FileInfo&	`info`)

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

Role: 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 to 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

Effect: Read-only

Journal: Not Available

Parameters:

mask: mask indicating fields to set.
info: info to be set.

This object is included in the file: kernapi.hxx