Reserved keywords in the library configuration
Do not use keywords for identifiers
If you enter →identifiers within the library configuration (e.g. the name for the library, best practice is to not use any of the following →keywords. If you use a reserved keyword as name, the name is highlighted as error.
Actually, only some of the following keywords are reserved keywords. This means you might use the other keywords as a name. Nevertheless, logi.cals recommends to not use any of the following keywords to uniquely distinguish the name of the library configuration from the keywords.
Keyword |
Meaning |
BASE_TEST_SOURCE |
define a directory where to search for the test execution files |
BINARIES |
together with END_BINARIES: define binaries |
COMMON_SOURCE |
reserved for system libraries |
COPYRIGHT |
define a copyright text |
DEPLOY |
define format for library element |
DISPLAYNAME |
define a short name |
END_BINARIES |
together with BINARIES: define binaries |
END_FOLDER |
together with FOLDER: define folders |
END_INCLUDES |
together with INCLUDES: define includes |
END_LIBRARY |
together with LIBRARY: define libraries |
END_SOURCES |
together with SOURCES: define source files |
FILE |
define files |
FLATCOPY |
reserved for the future |
FOLDER |
together with END_FOLDER: define folders |
FOR |
after BINARIES, INCLUDES or SOURCES: define platform |
IEC |
define library element |
IMPLEMENTS_LOGICALS_LIB |
reserved for system libraries |
INCLUDES |
together with END_INCLUDES: define includes |
INTERFACE |
possible value for DEPLOY |
LIBRARY |
together with END_LIBRARY: define libraries |
LIBRARYTYPE |
define the library type (together with LOGICAD, LOGIWEBoder LOGISAFE) |
LOGICAD |
define library as type "logi.CAD 3 library" |
LOGIWEB |
define library as type "logi.WEBlibrary" |
LOGISAFE |
define library as type "logi.SAFE library" |
OBJECT |
reserved for the future |
PACKAGETYPE |
define compression format |
PASSWORD |
reserved for the future |
PRIVATE |
possible value for VISIBILITY |
PTK_FOR_LIBRARY_BUILD |
define platform for logi.WEB or logi.SAFE library |
PROVIDER |
a keyword from a library reference |
PUBLIC |
possible value for VISIBILITY |
RECURSIVE |
reserved for the future |
SiLCoverageReviewed |
define an exception that full test coverage is not required for logi.WEB or logi.SAFE library |
SOURCE |
possible value for DEPLOYalso a keyword from a library reference |
SOURCEPATH |
define additional path (in case of FILE) |
SOURCES |
together with END_SOURCES: define source files |
SUMMARY |
define the intended usage |
SUPPORTED_PTKS |
define platforms for logi.CAD 3 |
USES |
references a different library |
VENDOR |
define a vendor |
VERSION |
define version number |
VISIBILITY |
define visibility of library element |
Information on the purpose of these keywords can be found under: