#[repr(C)]pub struct eric_druck_parameter_t {
pub version: u32,
pub vorschau: u32,
pub ersteSeite: u32,
pub duplexDruck: u32,
pub pdfName: *const byteChar,
pub fussText: *const c_char,
pub pdfCallback: EricPdfCallback,
pub pdfCallbackBenutzerdaten: *mut c_void,
}Expand description
@brief Diese Struktur enthält alle für den Druck notwendigen Informationen.
Der Anwendungsentwickler muss diese Struktur allokieren und nach Verwendung wieder freigeben.
Fields§
§version: u32@brief Version dieser Struktur. Die Version muss derzeit 2 oder 3 sein. Bei Änderungen dieser Struktur wird dieser Wert inkrementiert.
@note Bei einem Wert ungleich 2 oder 3 wird #ERIC_GLOBAL_UNGUELTIGE_PARAMETER_VERSION zurückgegeben und eine Fehlermeldung in die Logdatei geschrieben. Bei Version 2 werden die Attribute @c pdfCallback und @c pdfCallbackBenutzerdaten vom ERiC nicht berücksichtigt!
vorschau: u32@brief Soll ein Vorschau-PDF erstellt werden?
- vorschau = 1: Ein Vorschau-PDF wird erzeugt und als solches gekennzeichnet.
- vorschau = 0: Es wird kein Vorschau-PDF erzeugt.
@note Bei Werten ungleich 0 oder 1 wird #ERIC_GLOBAL_UNGUELTIGER_PARAMETER zurückgegeben und eine Fehlermeldung in die Logdatei geschrieben.
ersteSeite: u32@brief Soll das PDF nur die erste Seite oder alles enthalten?
- ersteSeite = 1: Es wird nur die erste Seite einer komprimierten Erklärung gedruckt.
- ersteSeite = 0: Es wird alles gedruckt.
@note - Fachliche Informationen sind im ERiC-Entwicklerhandbuch.pdf nachzulesen. - Bei Werten ungleich 0 oder 1 wird #ERIC_GLOBAL_UNGUELTIGER_PARAMETER zurückgegeben und eine Fehlermeldung in die Logdatei geschrieben.
duplexDruck: u32@brief Soll die PDF-Datei für einen doppelseitigen Ausdruck mit Heftrand zum Lochen vorbereitet werden?
- duplexDruck = 1: Die geraden Seiten werden für einen Heftrand zum Lochen nach links eingerückt, 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.
@note Bei Werten ungleich 0 oder 1 wird #ERIC_GLOBAL_UNGUELTIGER_PARAMETER zurückgegeben und eine Fehlermeldung in die Logdatei geschrieben.
pdfName: *const byteChar@brief 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 Entwicklerhandbuch Kapitel “Ü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:
\n
@note 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.
fussText: *const c_char@brief Fußtext der auf dem Ausdruck verwendet werden soll (optional). @details 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!
@note Fachliche Informationen sind im ERiC-Entwicklerhandbuch.pdf nachzulesen.
pdfCallback: EricPdfCallback@brief 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.
pdfCallbackBenutzerdaten: *mut c_void@brief Zeiger auf Benutzerdaten, der bei einem Aufruf des @c pdfCallback vom ERiC als Parameter unverändert wieder an die Anwendung mitgegeben wird.
Trait Implementations§
Source§impl Clone for eric_druck_parameter_t
impl Clone for eric_druck_parameter_t
Source§fn clone(&self) -> eric_druck_parameter_t
fn clone(&self) -> eric_druck_parameter_t
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more