Iterator Types

This reference contains all the iterators that are available for the EPLAN 21 API.

Iterator Type

Short Description

EPL_ITERTYPE_WORKINGSET

Iterator for all open databases (main and subdatabases) of a working set

EPL_ITERTYPE_DATABASE

Iterator for all open databases

EPL_ITERTYPE_PARTS

Iterator for all parts of an object

EPL_ITERTYPE_CIRCUITPARTS

Iterator for all parts of a project/macro

EPL_ITERTYPE_COMPONENT_PART

Iterator for all portions of a device.

EPL_ITERTYPE_PARTSYMBOLS

Iterator for all symbols of a part

EPL_ITERTYPE_CABLES

Iterator for all cables of a project

EPL_ITERTYPE_CONNECTIONPOINTS

Iterator for the connections of a device/component

EPL_ITERTYPE_CONNECTIONS

Iterator for wires

EPL_ITERTYPE_CONTACTORS

Iterator for all contactors of a project

EPL_ITERTYPE_DEVICETAGS

Iterator for devices

EPL_ITERTYPE_FORMATENTRY

Iterator for parts of a format string

EPL_ITERTYPE_FORMS

Iterator for all forms of a working set/project/macro

EPL_ITERTYPE_GROUPS

Iterator for groups

EPL_ITERTYPE_INSTANCES

Iterator for the instances of an object

EPL_ITERTYPE_LAYER

Iterator for all layers of a page

EPL_ITERTYPE_LOCATIONS

Iterator for locations

EPL_ITERTYPE_MACROS

Iterator for all macros of a working set

EPL_ITERTYPE_NODES

Iterator for all autoconnect lines of a project/macro, or a potential definition

EPL_ITERTYPE_PAGES

Iterator for all pages of a project/macro

EPL_ITERTYPE_PLOTFRAMES

Iterator for all plot frames of a working set or a project/macro

EPL_ITERTYPE_PLUGS

Iterator for all plugs of a project

EPL_ITERTYPE_POTENTIALDEFS

Iterator for all potential definitions

EPL_ITERTYPE_INTERRUPTIONPOINT_CODES

Iterator for all potential interruption-point lists

EPL_ITERTYPE_INTERRUPTIONPOINTS

Iterator for all potential interruption-points

EPL_ITERTYPE_PROJECTS

Iterator for all projects of a project database

EPL_ITERTYPE_PROPDEFS

Iterator for all property definitions

EPL_ITERTYPE_PROPERTIES

Iterator for the properties determined for an object

EPL_ITERTYPE_ROLES

Iterator for all valid user groups

EPL_ITERTYPE_SYMBOLFILES

Iterator for all symbol files

EPL_ITERTYPE_SYMBOLS

Iterator for all symbols of a symbol file

EPL_ITERTYPE_TERMINALS

Iterator for the terminals of a terminal strip

EPL_ITERTYPE_TERMINALSTRIPS

Iterator for all terminal strips of a project

 

EPL_ITERTYPE_WORKINGSET

Iterator for all open databases (main and subdatabases) of a working set. The following parent type is permitted:


 

EPL_ITERTYPE_DATABASE

Iterator for all open databases. The following parent types are permitted:

Without a parent the iterator iterates through all open main databases, but not through open subdatabases.

With a parent, the iterator iterates through all open databases of the associated working set. In this case, however, the iterator does not get the database used as parent, in contrast to the EPL_ITERTYPE_WORKINGSET iterator.


 

EPL_ITERTYPE_PARTS

Iterator for all parts of an object. The following parent types are permitted:


 

EPL_ITERTYPE_CIRCUITPARTS

Iterator for all parts of a project or macro.
In contrast to the EPL_ITERTYPE_PARTS iterator, only the parts of the project or macro are inserted in the iterator.
The following parent types are permitted:


 

EPL_ITERTYPE_COMPONENT_PART

Iterator for all portions (components) of a device. The following parent types are permitted:


 

EPL_ITERTYPE_PARTSYMBOLS

Iterator for all symbols of a part. The following parent types are permitted:


 

EPL_ITERTYPE_CABLES

Iterator for all cables of a project. The following parent types are permitted:


 

EPL_ITERTYPE_CONNECTIONPOINTS

Iterator for the connections of a device or component. The following parent types are permitted:


 

EPL_ITERTYPE_CONNECTIONS

Iterator for wires. The following parent types are permitted:


 

EPL_ITERTYPE_CONTACTORS

Iterator for all contactors of a project. The following parent types are permitted:


 

EPL_ITERTYPE_DEVICETAGS

Iterator for devices. The following parent types are permitted:


 

EPL_ITERTYPE_FORMATENTRY

Iterator for parts of a format string. The following parent types are permitted:


 

EPL_ITERTYPE_FORMS

Iterator for all forms of a working set or all forms of a project or macro. The following parent types are permitted:


 

EPL_ITERTYPE_GROUPS

Iterator for groups. The following parent types are permitted:

If the parent is of the EPL_OBJECTTYPE_GROUP type the subgroups of a group are iterated through.


 

EPL_ITERTYPE_INSTANCES

Iterator for the instances of an object. The following parent types are permitted:


 

EPL_ITERTYPE_LAYER

Iterator for all layers of a page. The following parent types are permitted:


 

EPL_ITERTYPE_LOCATIONS

Iterator for locations. The following parent types are permitted:


 

EPL_ITERTYPE_MACROS

Iterator for all macros of a working set. The following parent types are permitted:


 

EPL_ITERTYPE_NODES

Iterator for all autoconnect lines (equi-potentials) of a project, macro, or a potential definition. The following parent types are permitted:


 

EPL_ITERTYPE_PAGES

Iterator for all pages of a project or macro. The following parent types are permitted:


 

EPL_ITERTYPE_PLOTFRAMES

Iterator for all plot frames of a working set or all plot frames of a project or macro. The following parent types are permitted:


 

EPL_ITERTYPE_PLUGS

Iterator for all plugs of a project. The following parent types are permitted:


 

EPL_ITERTYPE_POTENTIALDEFS

Iterator for all potential definitions of a project or macro. The following parent types are permitted:


 

EPL_ITERTYPE_INTERRUPTIONPOINT_CODES

Iterator for all potential interruption point lists of a project or macro. The iterator does not pass the individual interruption points. The following parent types are permitted:


 

EPL_ITERTYPE_INTERRUPTIONPOINTS

Iterator for all potential interruption-points of a interruption-point list. The following parent types are permitted:


 

EPL_ITERTYPE_PROJECTS

Iterator for all projects of a project database. The following parent types are permitted:


 

EPL_ITERTYPE_PROPDEFS

Iterator for all property definitions. The following parent types are permitted:


 

EPL_ITERTYPE_PROPERTIES

Iterator for the properties determined for an object. The following parent types are permitted:


 

EPL_ITERTYPE_ROLES

Iterator for all valid user groups. The parent handle is ignored.


 

EPL_ITERTYPE_SYMBOLFILES

Iterator for all symbol files of a working set or all symbol files of a project or macro. The following parent types are permitted:


 

EPL_ITERTYPE_SYMBOLS

Iterator for all symbols of a symbol file. The following parent types are permitted:


 

EPL_ITERTYPE_TERMINALS

Iterator for the terminals of a terminal strip. As an alternative, the EPL_ITERTYPE_COMPONENT_PART iterator can also be used. The following parent types are permitted:


 

EPL_ITERTYPE_TERMINALSTRIPS

Iterator for all terminal strips of a project. The following parent types are permitted: