The name provided can be an archive file, the name of an Xic cell, or a library file. If the name of an archive file is given, the name of the cell to open can be provided as symname. If symname is null or empty, the top level cell (the one not used as a subcell by any other cells in the file) is the one opened for editing. If there is more than one top level cell, in graphics mode the user is presented with a pop-up choice menu and asked to make a selection. If the file is a library file, the symname can be given, and it should be one of the reference names from the library, or the name of a cell defined in the library. If symname is null or empty, in graphics mode a pop-up listing the library contents will appear, allowing the user to select a reference or cell. If not in graphics mode, and the cell to edit can not be determined, the current cell is unchanged, and nothing is read.
The symname must be the name after any aliasing is applied.
When reading an archive file, the dimensions are scaled according to the current scale for reading. This scale can be set with the SetConvertScale function, or from the Conversion - Import panel in Xic.
The return value is one of the following integers, representing the command status:
-2 | The function call was reentered. This is not likely to happen in scripts. |
-1 | The user aborted the operation. |
0 | The open failed: bad file name, parse error, etc. |
1 | The operation succeeded. |
2 | The read was successful on an archive with multiple top-level symbols but the symbol to edit can't be determined. The current cell has not been set, but the cells are in memory. The second argument could have been used to resolve the ambiguity. |
3 | The cell name was the name of the device library or model library file, which has been opened for text editing (in graphic mode only). |
When reading an archive file, the cell is scaled according to the current scale for reading. This scale can be set with the SetConvertScale function, or from the Conversion - Import panel in Xic.
The return value is 1 on success, 0 otherwise.
The return value is the number of objects deleted.
This function implicitly calls Commit before the context change.
This function implicitly calls Commit before the context change.
CGX | .cgx |
CIF | .cif |
GDSII | .gds |
OASIS | .oas |
The default format will be the format of the original input file, though format conversion can be imposed by adding one of these suffixes or ``.xic'' to newname. The cell is saved unconditionally; there is no user prompt.
Note that only modified or internally created cells will be written. To write all cells as native cell files, use the ToXIC function.