Barcode API: Grafiken aus eigener Applikation erzeugen

Barcode Vectorizer gibt es als Standard und als Pro Edition. Letztere erweitert das Programm um die Möglichkeit (API), hochwertige Barcode-Grafiken aus der eigenen Applikation heraus im Hintergrund zu generieren.

Barcode Generator API – Die Schnittstelle

Die API-Schnittstelle ist eine ausführbare Datei mit dem Namen bcvc.exe, welche sich im Installationsordner des Programms befindet. Hilfe zur Benutzung erhalten Sie durch einen parameterlosen Aufruf dieser Datei von der Kommandozeile:

Syntax

Syntax: bcvc.exe [options] BarcodeNumber DesignFile OutputFile
Beispiel: bcvc.exe -hres=600 -vres=600 -colorspace=cmyk "123456" design.bcvp output.eps

Die drei Parameter BarcodeNumber, DesignFile und OutputFile müssen jeweils in Anführungszeichen gesetzt werden, falls sie Leerzeichen enthalten. Das Ziel-Grafikformat ermittelt die API automatisch aus der Dateiendung von OutputFile. Zulässig sind die Dateiendungen: .pdf .eps .svg .png .bmp .jpg .jpeg. Die Datei DesignFile verweist auf die im GUI-Modus vorgefertigte Vorlage.

Zusammen mit der Barcode-Nummer kann – bei Barcode-Typen, bei denen dies vorgesehen ist – optional eine Add-On-Nummer übermittelt werden. Dazu muss Letztere getrennt durch ein #-Zeichen hinter die Erstere geschrieben werden. Beispiel einer GTIN-13 (EAN-13) mit Add-On 5:

4013456367128#12345

Als [options] stehen folgende Parameter zur Verfügung:

-hres und -vres – Horizontale und vertikale Auflösung (dpi) für die zu generierende Grafik. Die beiden Parameter sind optional für Vektorformate, vorgeschrieben für Rasterformate.

-tiffres – Nur für EPS: Auflösung (dpi) für die eingebettete TIFF-Vorschau. Default-Wert ist 240, bei 0 wird eine EPS-Datei ohne Vorschau generiert.

-colorspace – RGB (default) oder CMYK. Der Parameter ist optional und wird ignoriert, falls das Zielformat ein anderes ist als PDF oder EPS.

-designindex – Index (Ordnungsnummer) der Vorlage innerhalb von "DesignFile". Optionaler Parameter, Default-Wert ist 1.

Fehlerbehandlung

Beim Beenden liefert die API einen sogenannten Exit Code zurück – in der Programmierung von Batch-Dateien auch als ERRORLEVEL bekannt. Der Exit Code ist im Allgemeinen eine Ganzzahl, welche Auskunft darüber gibt, auf welche Weise und mit welchem Ergebnis ein Programm beendet wurde. Programmiersprachen, welche in der Lage sind, (externe) Prozesse zu starten, stellen idR. auch Funktionen bzw. Methoden zum Abfragen des Exit Code nach Beendigung eines Prozesses zur Verfügung. Ein aufrufendes Programm kann sich dieser Funktionen bedienen, um auf mögliche Zustände und Fehler entsprechend zu reagieren.

Exit Codes:

0 – Generieren der Barcode-Grafik erfolgreich abgeschlossen.
1 – Ungültige Anzahl von Parametern.
11 – "-hres" muss eine Ganzzahl größer als 0 sein.
12 – "-hres"-Parameter ist erforderlich, da Rasterformat (PNG, BMP, JPG).
13 – "-vres" muss eine Ganzzahl größer als 0 sein.
14 – "-vres"-Parameter ist erforderlich, da Rasterformat (PNG, BMP, JPG).
18 – "-tiffres" muss größer oder gleich 0 sein.
20 – Etwas anderes als RGB oder CMYK wurde als "-colorspace" übergeben.
30 – "-designindex" muss eine Ganzzahl zwischen 1 und 20 sein.
31 – "-designindex" ist größer als die tatsächliche Anzahl Vorlagen in "DesignFile".
40 – "DesignFile" nicht gefunden.
41 – Fehler beim Lesen von "DesignFile".
50 – "OutputFile" besitzt keine der unterstützten Dateiendungen.
51 – Verzeichnis für "OutputFile" existiert nicht.
52 – Fehler beim Schreiben von "OutputFile".
60 – Barcode-Nummer ist mit dem vorliegenden Barcode-Typ nicht darstellbar.
70 – Nicht genügend Arbeitsspeicher, evtl. ist die Auflösung unrealistisch hoch gewählt.