Diese API-Referenz enthält detaillierte Informationen der ERiC API-Funktionen, Typdefinitionen, Aufzählungen, Datenstrukturen und Headerdateien. Die Funktionsdeklarationen für die ERiC Multithreading-API werden in ericmtapi.h, die Deklarationen der Singlethreading-API in ericapi.h bereitgestellt.

In erictoolkit.h werden Prüffunktionen bereitgestellt, deren Funktionalität identisch zu denen in ericapi.h und ericmtapi.h ist. Die erictoolkit.h hat keine Abhängigkeiten zu anderen ERiC-Bibliotheken und kann somit unabhängig von diesen eingesetzt werden.

Suchfunktion

Die ERiC API-Referenz im HTML-Format enthält ein Suchfeld mit integrierter Filterfunktion. Damit können Sie eine gezielte Suche nach Symbolen durchführen.
Voraussetzung: In Ihrem Browser ist JavaScript aktiviert.

Für eine Volltextsuche nutzen Sie bitte die PDF-Ausgabe der ERiC API-Referenz. Siehe ERiC-API-Referenz.pdf.

Dokumentation

Das Dokumentationspaket beinhaltet:

Das ERiC-Entwicklerhandbuch.pdf. Hier finden Sie sowohl allgemeine Zusatzinformationen als auch spezielle Hinweise zum Gebrauch der Bibliotheken, Datensätze, Datensatzformate und Werte.
Das ERiC-Tutorial.pdf. Es illustriert detailliert die Softwareentwicklung mit ERiC an den mitgelieferten Beispielen ericdemo und ottodemo.
Die ERiC-Releasenotes.pdf. Sie enthalten die Änderungen der aktuell unterstützten ERiC Releases.
Die Datenartversionmatrix.xml. Sie enthält eine Übersicht der datenartVersionen, die ERiC unterstützt. Einige API-Funktionen verwenden die datenartVersion als Parameter, weitere Informationen siehe ERiC-Entwicklerhandbuch.pdf, Kap. "datenartVersion – Definition und Verwendung."
Diese API-Referenz sowie die Dokumentation aller Feldkennungen, Plausibilitätsprüfungen, Schemata und Schnittstellenbeschreibungen.

Encoding und Zeichensatz

Alle Daten, die an die ELSTER Annahmeserver übermittelt werden, sind in UTF-8 zu kodieren. Hierbei dürfen die zu übermittelnden Daten keine BOM (=Byte Order Mark) enthalten.

Der Datentyp char zeigt an, wo UTF-8 kodierte Zeichenketten zu verwenden sind. Der Datentyp byteChar zeigt an, wo ASCII zu verwenden ist bzw. bei Pfadangaben das betriebssystemspezifische Encoding, siehe ERiC-Entwicklerhandbuch.pdf, Kap. "Übergabe von Pfaden an ERiC API-Funktionen."

Die erlaubte Zeichenmenge lässt sich dem Datentyp BaseStringSType aus dem ElsterBasisSchema headerbasis_datentypen.xsd der Schnittstellenbeschreibung entnehmen.

Bei der Eingabe von PINs sind nur Zeichen aus dem ASCII Zeichensatz, ohne Sonder- und Steuerzeichen, erlaubt, siehe https://de.wikipedia.org/wiki/ASCII.