PdfClose

obj -> PdfClose([alpha1[, int2[, alpha3[, alpha4[, alph5]]]]]) : int

PDF-Objekt schließen

Details

• obj: Deskriptor des PDF-Objekts
• alpha1: Dateiname der zu schreibenden Datei (optional)
• int2:
  • Schreibmodus (optional):
  • _PdfModePdfNormal
  • _PdfModePdfA
  • _PdfModePdfANormal
  • _PdfModePdfA2b
  • _PdfModePdfA2bNormal
  • _PdfModePdfA3b
  • _PdfModePdfA3bNormal
  • _PdfModeCancel
  • _PdfModePdfZUGFeRDBasic
  • _PdfModePdfZUGFeRDComfort
  • _PdfModePdfZUGFeRDExtended
  • _PdfModePdfZUGFeRD10
  • _PdfModePdfZUGFeRD20
  • _PdfModePdfZUGFeRD21
  • _PdfModePdfZUGFeRDXRechnung
• alpha3: Dateipfad für Fehlerlog (optional).
• alpha4: (optional) Dateipfad der Zertifikatsdatei (X.509) für digitale Signierung.
• alpha5: Passwort der Zertifikatsdatei.
• Resultat: int Fehlerwert
• Siehe: Verwandte Befehle , Blog

Mit dieser Anweisung wird ein zuvor mit PdfNew () erstelltes bzw. PdfOpen () geöffnetes PDF-Dokument zurückgeschrieben und das Objekt entfernt. Alle an dem Dokument durchgeführten Änderungen werden erst zu diesem Zeitpunkt in die Datei geschrieben.

Der Deskriptor des PDF-Dokuments wird als (obj) angegeben. Die zu schreibende Datei kann in (alpha1) übergeben werden. Wird kein Dateiname angegeben, wird das Dokument nicht geschrieben. In (int2) kann eine der folgenden Konstanten angegeben werden:

• _PdfModePdfNormal Es wird ein normales PDF-Dokument erzeugt.
• _PdfModePdfA Es wird ein PDF/A-1b:2005 konformes Dokument erzeugt.
• _PdfModePdfANormal Es wird versucht ein PDF/A-1b:2005 konformes Dokument zu erzeugen. Gelingt dies nicht, wird ein normales PDF-Dokument erstellt und _ErrPdfNotPdfA zurückgegeben.
• _PdfModePdfA2b Es wird ein PDF/A-2b:2011 konformes Dokument erzeugt.
• _PdfModePdfA2bNormal Es wird versucht ein PDF/A-2b:2011 konformes Dokument zu erzeugen. Gelingt dies nicht, wird ein normales PDF-Dokument erstellt und _ErrPdfNotPdfA zurückgegeben.
• _PdfModePdfA3b Es wird ein PDF/A-3b:2012 konformes Dokument erzeugt.
• _PdfModePdfA3bNormal Es wird versucht ein PDF/A-3b:2012 konformes Dokument zu erzeugen. Gelingt dies nicht, wird ein normales PDF-Dokument erstellt und _ErrPdfNotPdfA zurückgegeben.
• _PdfModePdfZUGFeRDBasic Erstellung eines ZUGFeRD-konformen PDF mit Basic-Profil.
• _PdfModePdfZUGFeRDComfort Erstellung eines ZUGFeRD-konformen PDF mit Comfort-Profil.
• _PdfModePdfZUGFeRDExtended Erstellung eines ZUGFeRD-konformen PDF mit Extended-Profil.
• _PdfModePdfZUGFeRD10 Erstellung eines ZUGFeRD Version 1.0-konformen PDF.
• _PdfModePdfZUGFeRD20 Erstellung eines ZUGFeRD Version 2.0-konformen PDF.
• _PdfModePdfZUGFeRD21 Erstellung eines ZUGFeRD Version 2.1-konformen PDF.
• _PdfModePdfZUGFeRDXRechnung Erstellung eines ZUGFeRD Version 2.1-konformen PDF mit XRechnung-Profil.
• _PdfModeCancel Die Bearbeitung des PDF-Dokuments wird beendet, ohne das Dokument zu speichern.

Für ZUGFeRD-konforme PDFs kann je eine der Profil-Konstanten (_PdfModePdfZUGFeRDBasic, _PdfModePdfZUGFeRDComfort, _PdfModePdfZUGFeRDExtended) mit je einer der Versions-Konstanten (_PdfModePdfZUGFeRD10, _PdfModePdfZUGFeRD20, _PdfModePdfZUGFeRD21) kombiniert werden. Ist eine ZUGFeRD Profil-Konstante, jedoch keine Versions-Konstante angegeben, wird die Version 1.0 verwendet.

In (alpha3) kann als optionalen Parameter ein Dateipfad für einen ausführlichen Fehlerlog angegeben werden. Ist dieser Parameter vorhanden so erstellt das Programm diese Datei und befüllt sie in chronologischer Reihenfolge mit den Fehlern die eingetreten sind.

Bei der Erstellung einer PDF kann, sofern gewünscht, der Datei eine digitale Signierung hinzugefügt werden. Für die Signierung werden die optionalen Argumente (alpha4) und (alpha5) benötigt. In (alpha4) wird der Dateipfad des Zertifikats angegeben. In (alpha5) ist für das Zertifikat erforderliche Passwort anzugeben. Signierung von PDF und XML Dateien in conzept 16 Blog

info

Die Konformität des XML-Anhangs beim Generieren einer ZUGFeRD-PDF-Datei wird nicht gewährleistet. Die XML-Datei kann mit Schema-Dateien von FeRD überprüft werden. Fertige PDF-Dateien können hier validiert werden.

Folgende Fehlercodes können zurückgegeben werden:

• _ErrOk: Kein Fehler aufgetreten.
• _ErrGeneric: Es ist ein nicht spezifizierten Fehler aufgetreten.
• _ErrPdfNotPdfA: Es konnte kein PDF/A-konformes Dokument erstellt werden.
• _ErrOutOfMemory: Der zur Erstellung des PDF-Dokuments notwendige Hauptspeicher konnte nicht allokiert werden.
• _ErrFsiOpenFailed: Beim erstellen der externen Datei ist ein Fehler aufgetreten.

Mögliche Laufzeitfehler:

• _ErrHdlInvalid: Der in (obj) angegebene Deskriptor ist ungültig.
• _ErrValueInvalid: In (int2) wurde ein ungültiger Wert angegeben.