OpenSchematic

Opens a schematic given its file system path. The return value may be used with a number of other functions and commands. This function does not display the schematic.

The function GetSchematicTabs returns the IDs for all currently displayed schematics.

Arguments

Number Type Compulsory Default Description

1

string

Yes

File path

Argument 1

File system path to schematic file. The schematic does not need to be currently displayed

Returns

Return type: real

Returns an integer ID that can be used for a wide range of functions that return information about a schematic. It may also be used by some commands. If the schematic cannot be opened for any reason, the function returns -1.

Notes

The schematic ID may also be used by these commands: The handle returned by OpenSchematic may be closed using the function CloseSchematic. After a call to CloseSchematic, the handle will no longer be valid and any function it is supplied to will fail. However, it is not usually necessary to call CloseSchematic as handles are automatically closed when control returns to the command line.