Getting Started - Setup der Build-Umgebung

Das Kapitel beschreibt wie Sie mit dem API starten können.

Führen Sie nach der Installation der API die folgenden Schritte aus:

Öffnen Sie eine Shell/Eingabeaufforderung, in welcher der Compiler erreichbar ist.

Anmerkung: Öffnen Sie unter Windows die Eingabeaufforderung von Visual Studio: Start/Visual Studio 2022. Dadurch wird ein Verzeichnis geöffnet, in dem Sie x64 Native Tools Command Prompt auswählen müssen. Damit die Umgebung für VisualStudio 64Bit richtig eingestellt wird, muss der 64Bit VisualStudio Prompt über das Startmenü gestartet werden.
Anmerkung:
Wenn Sie eine neuere Visual Studio-Version verwenden, aber einen älteren Compiler installiert haben, können Sie die Visual Studio-Eingabeaufforderung mit dem folgenden Befehl öffnen. Beispiel für Visual Studio 2022 (V17) Enterprise Edition:
```
"C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x64 -vcvars_ver=14.4x
```
Setzen Sie die Umgebungvariable API_ROOT auf das Verzeichnis in dem API installiert wurde (wincc_oa_path/api).

Beispiele

Windows cmd:
```
set API_ROOT=C:\Siemens\Automation\WinCC_OA\3.20\api
```
C-Shell:
```
setenv API_ROOT /opt/WinCC_OA/3.20/api
```
Bash, Bourne-Shell:
```
export API_ROOT=/opt/WinCC_OA/3.20/api
```
Überprüfen Sie die Umgebung:

Für die Ausführung der new* Skripte ist die richtige Umgebung erforderlich.

Windows:

Geben Sie den Befehl %API_ROOT%\checkApiEnv in die Shell ein.

Die folgende Ausgabe wird angezeigt:
```
-------
found API_ROOT - good
found VC14.4x compiler - good
found cmake - good
done
-------
```
Linux:

Überprüfen Sie ob die richtige GCC-Version installiert ist:
```
gcc -v
```
Erstellen Sie ein Verzeichnis für das Projekt und navigieren Sie zu dem Verzeichnis, das Sie erstellt haben.

Erstellen Sie ein Projekt aus einer Vorlage mithilfe eines Skripts.

Die folgenden Vorlagenskripte befinden sich im Verzeichnis API_ROOT:


Skriptname	Beschreibung
`newWCCILManager`	Erstelle ein Manager-Developerprojekt.
`newWCCILDriver`	Erstelle ein Treiber-Developerprojekt.
`newWCCILCtrlExt`	Erstelle ein CTRL-Erweiterung DLL (plugin)-Developerprojekt.
`newEWO`	Erstelle ein EWO (External Widget Object)-Developerprojekt als Plug-in für Panels.
`newWCCOAAccessControlPlugin`	Erstelle ein Developerprojekt für eine AccessControl-Plug-in-Dll als Plug-in für alle Manager.
`newWCCILErrHdl`	Erstelle ein Developerprojekt für die External error handler-Dll als Plug-in für alle Manager.

Sie können die Skripte mit dem folgenden Befehl aufrufen:

Windows:

%API_ROOT%\<scriptname>.cmd <projectname>

Linux:

$API_ROOT/<scriptname>.sh <projectname>

Alle Skripte erstellen ein cmake-Projekt.

Erstellen Sie ein build-Verzeichnis (z.B. build) im root-Verzeichnis Ihres Projektes.
Verwenden Sie einen Generator Ihrer Wahl, um das Build-Verzeichnis zu erstellen:
```
cmake .. -G <generator>
```
Sie können eine Liste der Generatoren anzeigen:
```
cmake --help
```
Beispiel:

Verwenden Sie im Falle des CMake-Generators von Visual Studio die folgenden CMake-Argumente, um die richtige Visual Studio-Version und Compiler-Version festzulegen:
```
cmake -G "Visual Studio 16 2019" -A "x64" -T "v142" ..
```
Anmerkung:
Wir empfehlen die Verwendung eines der folgenden Generatoren:
- Visual Studio (auf Windows)
- Ninja
- Unix Makefiles
Starten Sie den Build. Der Build-Schritt hängt vom gewählten cmake-Generator ab.

Im Fall von Visual Studio können Sie die generierte Lösungsdatei öffnen und erstellen, indem Sie Folgendes verwenden:
```
devenv <projectname>.sln
```
Im fall von einem "make"-Generator, führen Sie einfach folgenden Befehl aus:
```
make
```
Oder Sie können auch einen Generator-unabhängigen Befehl verwenden:
```
cmake --build . --config RelWithDebInfo
```