Add_AdditionalReferencedFile

Methode (Function) · gibt Boolean zurück

Add_AdditionalReferencedFile ist eine Methode der Klasse Aloaha_ZUGFeRD.XML im Aloaha ZUGFeRD SDK. Sie betrifft BG-24 (Rechnungsbegründende Unterlagen), BT-122 (Kennung der rechnungsbegründenden Unterlage), BT-124 (Bezugsort der rechnungsbgegründenden Unterlage), BT-123 (Beschreibung der rechnungsbegründenden Unterlage).

Beschreibung (aus der SDK-Dokumentation): BG-24: Embeds a file from disk (Base64) as a document-level additional supporting document (ram:AdditionalReferencedDocument). Calls Add_AdditionalReferencedDocument internally. Upgrades a Basic profile to Comfort (EN 16931).

Rückgabe: True if the file was read and added, otherwise False with Last_Error set (e.g. FilePath does not exist, File is empty).

Deklaration

Public Function Add_AdditionalReferencedFile(ByVal FilePath As String, ByVal IssuerAssignedID As String, ByVal URIID As String, Optional ByVal TypeCode As String = "916", Optional ByVal Name As String = "", Optional ByVal ReferenceTypeCode As String = "", Optional ByVal IssueDateTime As String = "", Optional ByVal Document_DateFormat As String = "", Optional ByVal MimeType As String = "") As Boolean

Parameter

NameTypPflichtBeschreibung
FilePathStringerforderlichFull path of the file to embed (must contain a backslash and exist)
IssuerAssignedIDStringerforderlichBT-122: Supporting document reference
URIIDStringerforderlichBT-124: External document location
TypeCodeStringoptional (Standard: "916")Referenced document type code; default 916
NameStringoptional (Standard: "")BT-123: Supporting document description; defaults to the file name without extension
ReferenceTypeCodeStringoptional (Standard: "")BT-18-1: Scheme identifier (for invoiced object identifiers)
IssueDateTimeStringoptional (Standard: "")Document date, e.g. YYYYMMDD
Document_DateFormatStringoptional (Standard: "")Date format code, e.g. 102
MimeTypeStringoptional (Standard: "")BT-125-1: MIME type; if empty it is looked up from the registry, else derived for .pdf, .txt, .doc and .docx

Aufruf (VB.NET)

Dim alo As New Aloaha_ZUGFeRD.XML(Aloaha_ZUGFeRD.iXML.ZUGFeRDProfile.comfort, False, LicenseKey)
' …
Dim ergebnis = alo.Add_AdditionalReferencedFile(FilePath, IssuerAssignedID, URIID)

Business Terms (EN 16931)

Artikel mit Add_AdditionalReferencedFile

COM-Schnittstelle

Add_AdditionalReferencedFile ist Mitglied der Schnittstelle Aloaha_ZUGFeRD.iXML (Position 161 von 328) 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# mit Semikolon.