ERiC API-Referenz 43.3.2.0

Lade ...
Suche ...
Keine Treffer
Datenfelder
eric_druck_parameter_t Strukturreferenz

Diese Struktur enthält alle für den Druck notwendigen Informationen. Mehr ...

`#include <eric_types.h>`

Zusammengehörigkeiten von eric_druck_parameter_t:

## Datenfelder
uint32_t | version
| Version dieser Struktur. Die Version muss derzeit 4 sein. Bei Änderungen dieser Struktur wird dieser Wert inkrementiert.
uint32_t | vorschau
| Soll ein Vorschau-PDF erstellt werden?
uint32_t | duplexDruck
| Soll die PDF-Datei für einen doppelseitigen Ausdruck mit Heftrand zum Lochen vorbereitet werden?
const byteChar * | pdfName
| Pfad der erzeugten PDF-Datei.
const char * | fussText
| Fußtext der auf dem Ausdruck verwendet werden soll (optional).
EricPdfCallback | pdfCallback
| Optionale Angabe einer Callback-Funktion für die Übergabe eines PDFs vom ERiC an die Anwendung. Wenn hier eine Callback-Funktion angegeben wird, schreibt der ERiC PDFs nicht in eine Datei, sondern ruft stattdessen die Callback-Funktion auf. Wenn hier NULL angegeben wird, schreibt der ERiC die PDFs in Dateien.
void * | pdfCallbackBenutzerdaten
| Zeiger auf Benutzerdaten, der bei einem Aufruf des `pdfCallback` vom ERiC als Parameter unverändert wieder an die Anwendung mitgegeben wird.

## Ausführliche Beschreibung

Diese Struktur enthält alle für den Druck notwendigen Informationen.

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

Definiert in Zeile 227 der Datei eric_types.h.

## Dokumentation der Felder

## ◆ duplexDruck

uint32_t eric_druck_parameter_t::duplexDruck

Soll die PDF-Datei für einen doppelseitigen Ausdruck mit Heftrand zum Lochen vorbereitet werden?

Anwendungsfälle:

- duplexDruck = 1: Die geraden Seiten werden für einen Heftrand zum Lochen nach links eingerückt. Für Details siehe ERiC-Entwicklerhandbuch.pdf.
- duplexDruck = 0: Es erfolgt keine Einrückung der geraden Seiten. Das erstellte PDF ist nur zum blattweisen Ausdruck der Seiten vorgesehen.

Zu beachten
  Bei Werten ungleich 0 oder 1 wird ERIC_GLOBAL_UNGUELTIGER_PARAMETER zurückgegeben und eine Fehlermeldung in die Logdatei geschrieben.

Definiert in Zeile 258 der Datei eric_types.h.

## ◆ fussText

const char* eric_druck_parameter_t::fussText

Fußtext der auf dem Ausdruck verwendet werden soll (optional).

Wenn der übergebene Text länger als ERIC_MAX_LAENGE_FUSSTEXT Zeichen ist, dann bricht der Druck mit Fehlerkode ERIC_PRINT_FUSSTEXT_ZU_LANG ab!

Zu beachten
  Fachliche Informationen sind im ERiC-Entwicklerhandbuch.pdf nachzulesen.

Definiert in Zeile 297 der Datei eric_types.h.

## ◆ pdfCallback

EricPdfCallback eric_druck_parameter_t::pdfCallback

Optionale Angabe einer Callback-Funktion für die Übergabe eines PDFs vom ERiC an die Anwendung. Wenn hier eine Callback-Funktion angegeben wird, schreibt der ERiC PDFs nicht in eine Datei, sondern ruft stattdessen die Callback-Funktion auf. Wenn hier NULL angegeben wird, schreibt der ERiC die PDFs in Dateien.

Definiert in Zeile 306 der Datei eric_types.h.

## ◆ pdfCallbackBenutzerdaten

void* eric_druck_parameter_t::pdfCallbackBenutzerdaten

Zeiger auf Benutzerdaten, der bei einem Aufruf des `pdfCallback` vom ERiC als Parameter unverändert wieder an die Anwendung mitgegeben wird.

Definiert in Zeile 312 der Datei eric_types.h.

## ◆ pdfName

const byteChar* eric_druck_parameter_t::pdfName

Pfad der erzeugten PDF-Datei.

Pfade müssen auf Windows in der für Dateifunktionen benutzten ANSI-Codepage, auf Linux, AIX und Linux Power in der für das Dateisystem benutzten Locale und auf macOS in der "decomposed form" von UTF-8 übergeben werden. Weiterführende Informationen hierzu, sowie zu nicht erlaubten Zeichen in Pfaden und Pfadtrennzeichen, relative Pfadangabe, etc. siehe ERiC-Entwicklerhandbuch.pdf, Kap. "Übergabe von Pfaden an ERiC API-Funktionen".

Windows-Beispiel: `"c:\\test\\ericprint.pdf"`
Soll eine PDF-Datei angelegt werden, ist der `pdfName` zwingend erforderlich.

Besonderheiten bei Sammeldaten:
Für Sammeldaten wird dem PDF-Dateinamen vor der Dateiendung das Nutzdatenticket angefügt:
`<PDF-Dateiname>_<Nutzdatenticket>.pdf`

Optional kann der PDF-Dateiname den Platzhalter "%t" enthalten, der dann durch das Nutzdatenticket ersetzt wird:
`"%t_ericprint.pdf"` --> `"<Nutzdatenticket>_ericprint.pdf"`

Zu beachten
  Es ist sicherzustellen, dass alle PDF-Dateien im Dateisystem erstellt bzw. geschrieben werden können. Falls es beim Erstellen der PDF-Dokumente einen Fehler gibt oder falls diese nicht geschrieben werden können, wird die Bearbeitung abgebrochen, eine Log-Ausgabe erstellt, aus der hervorgeht, welcher Steuerfall nicht gedruckt werden konnte, und eine Fehlermeldung an den Aufrufer zurückgeliefert.

Definiert in Zeile 287 der Datei eric_types.h.

## ◆ version

uint32_t eric_druck_parameter_t::version

Version dieser Struktur. Die Version muss derzeit 4 sein. Bei Änderungen dieser Struktur wird dieser Wert inkrementiert.

Zu beachten
  Bei einem Wert ungleich 4 wird ERIC_GLOBAL_UNGUELTIGE_PARAMETER_VERSION zurückgegeben und eine Fehlermeldung in die Logdatei geschrieben.

Definiert in Zeile 235 der Datei eric_types.h.

## ◆ vorschau

uint32_t eric_druck_parameter_t::vorschau

Soll ein Vorschau-PDF erstellt werden?

Anwendungsfälle:

- vorschau = 1: Ein Vorschau-PDF wird erzeugt und als solches gekennzeichnet.
- vorschau = 0: Es wird kein Vorschau-PDF erzeugt.

Zu beachten
  Bei Werten ungleich 0 oder 1 wird ERIC_GLOBAL_UNGUELTIGER_PARAMETER zurückgegeben und eine Fehlermeldung in die Logdatei geschrieben.

Definiert in Zeile 247 der Datei eric_types.h.

Die Dokumentation für diese Struktur wurde erzeugt aufgrund der Datei:

- eric_types.h