Übersicht

Die Engine API's sind Dll basierte Schnittstellen für die Entwicklung von verschiedenen Diensten wie:

• Conversion Engines
• Recognition Engines
• Exportservices
• Userexits

Nachfolgend finden Sie übergreifende Informationen, welche für alle Engines und Schnittstellen gültig sind.

Allgemein

Funktionsdeklaration

Allgemein gilt folgende Funktionsdeklaration für alle Engines.

function MyEngineFunction( fCode : LongInt;
                           fData : PWideChar;
                           fSize : LongInt;
                           Msg   : PWideChar ) : LongInt;

ANSI und UNICODE Interfaces können in einer Engine gleichzeitig verwendet werden. Wobei das ANSI Interface lediglich zur Abwärtskompatibilität noch vorhanden ist.

Returncodes

Build Test

Diese Funktion ist für die interne Verwendung im clarc final builder implementiert und dient der automatischen Funktionsprüfung nach dem Build. Die Implementierung ist optional. 

Im Fehlerfall wird im Return ein Wert <> 0 und optional eine Fehlerbeschreibung zurückgegeben.

function ccBuildTest( fCode : LongInt;
                      fData : PWideChar;
                      Msg   : PWideChar ) : LongInt;

Funktionsdeklaration stdcall Support

Diese Funktion dient zur Prüfung, ob die Dll das stdcall Dll Interface unterstützt. Die Funktion darf nur dann implementiert werden. Bei der Standard pascal Interface Implementierung darf diese Funktion nicht exportiert werden.

function ccSTDCALLSupport : LongInt; stdcall;

Datentypen

Bei der Übergabe von Metadaten an die Engine-Schnittstellen werden diese entsprechend der unten aufgeführten Liste formatiert.

-128..127

-2147483648..2147483647

Speicherung von Konfigurationsdaten

Die Übergabe der Konfigurationsdaten erfolgt in einem vom Schnittstellen-Entwickler selbst definierten Format. Es wird hierbei keine Prüfung durch die führende Anwendung durchgeführt.

Als Standard empfehlen wir ein XML-String mit folgendem Aufbau (hier am Beispiel der Konfigurationsdaten des EASY XML-Server Exportservice):

<?xml version="1.0" encoding="UTF-8" ?>
<ccConfig>
  <xSrvWebRoot>http://eexserver:8080</xSrvWebRoot> 
  <UserName>superadmin</UserName> 
  <Password>abc</Password> 
  <DebugPath>c:\temp\</DebugPath> 
  <Debug>False</Debug> 
</ccConfig> 

Einfache Config-Strings wie der nachfolgende können ebenfalls problemlos verwendet werden:

xSrvWebRoot=http://eexserver:8080;UserName=superadmin;Password=abc;DebugPath=c:\temp\;Debug=False

In diesem Beispiel müsste lediglich darauf geachtet werden, dass keine „;“-Zeichen eingegeben werden können.

Nutzungshinweise

Bitte beachten Sie folgende Hinweise zur Nutzung der Engine API's.