eric developers toolkit - ?· iii inhaltsverzeichnis api-referenz

Download ERiC Developers Toolkit -  ?· iii Inhaltsverzeichnis API-Referenz

Post on 29-Jul-2018

288 views

Category:

Documents

1 download

Embed Size (px)

TRANSCRIPT

  • i

    ERiC Developers Toolkit

    Version 19.5.2.0

  • ii

  • iii

    Inhaltsverzeichnis API-Referenz ................................................................................................................................................................. 2

    Willkommen............................................................................................................................................................... 2 Suchfunktion .............................................................................................................................................................. 2

    Datenstruktur-Verzeichnis ............................................................................................................................................. 3 Datei-Verzeichnis ........................................................................................................................................................... 4 Datenstruktur-Dokumentation ........................................................................................................................................ 5

    eric_druck_parameter_t .............................................................................................................................................. 5 eric_verschluesselungs_parameter_t .......................................................................................................................... 8 eric_zertifikat_parameter_t ...................................................................................................................................... 10 Finanzamtsdaten ....................................................................................................................................................... 13 FinanzamtsdatenNeu ................................................................................................................................................ 17

    Datei-Dokumentation ................................................................................................................................................... 21 eric_fehlercodes.h .................................................................................................................................................... 21 eric_types.h .............................................................................................................................................................. 31 ericapi.h .................................................................................................................................................................... 34 Inhalt des Rckgabepuffers und des Serverantwortpuffers ...................................................................................... 38

    Erfolgsfall............................................................................................................................................................. 38 Plausibilittsfehler ................................................................................................................................................ 38 Fehler in der Serverantwort .................................................................................................................................. 38 Sonstige Fehler ..................................................................................................................................................... 39

    UI-Callbacks ............................................................................................................................................................ 39 ericapiExport.h ......................................................................................................................................................... 55 ericdef.h ................................................................................................................................................................... 56 ericdef_gui.h ............................................................................................................................................................ 58 mainpage.txt ............................................................................................................................................................. 64 platform.h ................................................................................................................................................................. 65 tm98ericapi.h............................................................................................................................................................ 67

    Index ............................................................................................................................................................................ 83

  • 1

  • 2

    API-Referenz

    Willkommen

    Auf diesen Seiten finden Sie Referenzinformationen ber die von ERiC angebotenen API-Funktionen.

    Beginnen Sie nach dem Auspacken des mitgelieferten Common-Pakets im Dokument

    ERiC-/common/ERiC-Entwicklerhandbuch.pdf

    In diesem Dokument finden Sie sowohl allgemeine Zusatzinformationen als auch spezielle Hinweise zum

    Gebrauch der Bibliotheken, Datenstze, Datensatzformate und Werte.

    Das ESt-Tutorial

    ERiC-/common/Tutorial/ERiC-ESt-Tutorial.pdf

    illustriert detailliert die Softwareentwicklung mit ERiC am mitgelieferten Beispiel ericdemo.

    Suchfunktion

    Die HTML-Seiten der API-Referenz enthalten ein Suchfeld. Voraussetzung ist ein Browser mit

    aktiviertem JavaScript. Es kann nur nach Symbolen gesucht werden. Eine Volltextsuche ist nicht mglich.

  • 3

    Datenstruktur-Verzeichnis

    Datenstrukturen Hier folgt die Aufzhlung aller Datenstrukturen mit einer Kurzbeschreibung:

    eric_druck_parameter_t (Diese Struktur enhlt alle fr den Druck notwendigen Informationen ) ................................................................................................................................................................. 5

    eric_verschluesselungs_parameter_t (Fr die Signatur oder Authentifizierung bentigte Informationen ) ................................................................................................................................................................. 8

    eric_zertifikat_parameter_t (Struktur mit Informationen zur Erzeugung von Zertifikaten mit

    EricCreateKey ) .................................................................................................................................. 10

    Finanzamtsdaten (Wird von EricHoleFinanzamtsdaten bentigt ) ............................................... 13

    FinanzamtsdatenNeu (Wird von EricHoleFinanzamtsdatenNeu bentigt. Oeffnungszeichen und

    Bemerkung sind lnger - siehe ERIC-21598 ) .................................................................................. 17

  • 4

    Datei-Verzeichnis

    Auflistung der Dateien Hier folgt die Aufzhlung aller Dateien mit einer Kurzbeschreibung:

    eric_fehlercodes.h (Aufzhlung der ERIC API-Fehlercodes ) ....................................................... 21

    eric_types.h (Einfache Aufzaehlungstypen und Strukturen ) ........................................................ 31

    ericapi.h (Deklaration der ERiC API-Funktionen ) ........................................................................ 34

    ericapiExport.h (DLL-Export- und Importdeklarationen ) ........................................................... 55

    ericdef.h (Konstanten fr bergabe- und Druckparameter ) ........................................................ 56

    ericdef_gui.h (Konstanten und Typdeklarationen fr Callbackfunktionen ) ............................... 58

    platform.h (Konstanten fr verschiedene Betriebssystemplattformen ) ....................................... 65

    tm98ericapi.h (Deklaration der ERiC API-Funktionen ) ............................................................... 67

  • 5

    Datenstruktur-Dokumentation

    eric_druck_parameter_t Strukturreferenz

    Diese Struktur enhlt alle fr den Druck notwendigen Informationen. #include

    Zusammengehrigkeiten von eric_druck_parameter_t:

    Datenfelder

    uint32_t vorschau

    Soll ein Vorschau-PDF erstellt werden?

    uint32_t ersteSeite

    Soll das PDF nur die erste Seite oder alles enthalten?

    const char * pdfName

    Name der erzeugten PDF-Datei.

    const char * fussText

    Fusstext der auf dem Ausdruck verwendet werden soll (optional).

    Ausfhrliche Beschreibung

    Diese Struktur enhlt alle fr den Druck notwendigen Informationen.

    Der Anwendungsentwickler muss diese Struktur allokieren und nach Verwendung wieder freigeben.

    Definiert in Zeile 124 der Datei eric_types.h.

    Dokumentation der Datenelemente

    uint32_t eric_druck_parameter_t::ersteSeite

    Soll das PDF nur die erste Seite oder alles enthalten?

    ersteSeite = 1: Es wird nur die erste Seite einer komprimierten Erklrung gedruckt.

    ersteSeite = 0: Es wird alles gedruckt.

    Definiert in Zeile 139 der Datei eric_types.h.

  • 6

    const char* eric_druck_parameter_t::fussText

    Fusstext der auf dem Ausdruck verwendet werden soll (optional).

    Wenn der uebergebene Text laenger als ERIC_MAX_LAENGE_FUSSTEXT Zeichen ist, dann bricht

    der Druck mit Fehlerkode ERIC_PRINT_FUSSTEXT_ZU_LANG ab!

    Zu beachten:

    Fachliche Informationen sind in ERiC-Entwicklerhandbuch.pdf nachzulesen.

    Definiert in Zeile 186 der Datei eric_types.h.

    const char* eric_druck_parameter_t::pdfName