MergeXMLIntoPDFWait4PDF() – ZUGFeRD SDK API

MergeXMLIntoPDFWait4PDF ist eine Methode der Klasse Aloaha_ZUGFeRD.XML im Aloaha ZUGFeRD SDK.

Beschreibung (Originaltext der englischen SDK-Dokumentation): Like MergeXMLIntoPDF, but first waits until the input PDF exists, is readable and is not locked (e.g. while another process is still writing it).

Rückgabe: True on success; False otherwise, including when the input PDF did not become accessible in time (see Last_Error).

Deklaration

Public Function MergeXMLIntoPDFWait4PDF(ByVal XMLPath As String, ByVal PDFInputPath As String, ByVal PDFOutputPath As String, Optional ByVal DoOverWrite As Boolean = False, Optional ByVal waitTimeInMilliseconds As Integer = 0, Optional ByVal AdditionalFile As String = "", Optional ByVal LicenseKey As String = "", Optional ByVal Author As String = "", Optional ByVal Title As String = "", Optional ByVal Subject As String = "", Optional ByVal Keywords As String = "") As Boolean

Parameter

Name	Typ	Pflicht	Beschreibung
`XMLPath`	`String`	erforderlich	Path of the invoice XML file
`PDFInputPath`	`String`	erforderlich	Path of the input PDF file
`PDFOutputPath`	`String`	erforderlich	Path of the output PDF file; if empty the input file is overwritten
`DoOverWrite`	`Boolean`	optional (Standard: `False`)	True allows overwriting an existing output file (default False)
`waitTimeInMilliseconds`	`Integer`	optional (Standard: `0`)	Maximum time to wait for the input PDF, checked every 100 ms (default 0 = check once)
`AdditionalFile`	`String`	optional (Standard: `""`)	Optional path of an additional file to embed
`LicenseKey`	`String`	optional (Standard: `""`)	Licence key; if empty the key already set on the object, the global key or a key stored in the registry is used
`Author`	`String`	optional (Standard: `""`)	PDF author; if empty the seller name from the XML is used
`Title`	`String`	optional (Standard: `""`)	PDF title; if empty "Invoice: " followed by the invoice number from the XML is used
`Subject`	`String`	optional (Standard: `""`)	PDF subject; if empty the PaymentReference property of this object (not of the merged XML) is used; double quotes are removed
`Keywords`	`String`	optional (Standard: `""`)	PDF keywords; if empty "XRechnung, XInvoice, ZUGFeRD" plus the buyer name is used

Aufruf (VB.NET)

Dim alo As New Aloaha_ZUGFeRD.XML(Aloaha_ZUGFeRD.iXML.ZUGFeRDProfile.comfort, False, "IHR-LIZENZSCHLUESSEL")
Dim XMLPath As String = ""
Dim PDFInputPath As String = ""
Dim PDFOutputPath As String = ""
If Not alo.MergeXMLIntoPDFWait4PDF(XMLPath, PDFInputPath, PDFOutputPath) Then
    Console.WriteLine("Fehler: " & alo.Last_Error)
End If

Aufruf (C#)

var alo = new Aloaha_ZUGFeRD.XML(Aloaha_ZUGFeRD.iXML.ZUGFeRDProfile.comfort, false, "IHR-LIZENZSCHLUESSEL");
string xmlPath = "";
string pdfInputPath = "";
string pdfOutputPath = "";
if (!alo.MergeXMLIntoPDFWait4PDF(xmlPath, pdfInputPath, pdfOutputPath))
{
    Console.WriteLine("Fehler: " + alo.Last_Error);
}

COM-Schnittstelle

MergeXMLIntoPDFWait4PDF ist Mitglied der Schnittstelle Aloaha_ZUGFeRD.iXML (Position 284 von 343) und damit auch aus VB6, VBA/Access und anderen COM-Clients über CreateObject("Aloaha_ZUGFeRD.XML") aufrufbar. Neue Mitglieder werden immer am Ende von iXML angefügt, damit bestehende COM-Clients unverändert weiterlaufen; nach einem Update die Typbibliothek neu registrieren.

Quelle: XML-Dokumentationskommentare des Aloaha ZUGFeRD SDK (xml.vb). Gleiche Signatur in VB6/VBA über COM. In C# werden ByRef-Parameter mit ref übergeben, VB-Eigenschaften mit Parametern heißen get_…/set_…, optionale Parameter können entfallen.