N2PDFAddAttachment ( <JobID>, <ContentType>, <ContentOption>, <ServerName>, <DatabaseName>, <UNID>, <ItemName>, <AttachmentName> ) -> <ErrorCode>
Beschreibung
Mit dieser Funktion können Sie Anhänge aus einem Notes-Dokument importieren, konvertieren, einbetten oder als externe Verlinkung dem PDF hinzufügen. Über die Funktion N2PDFSetOption mit dem Parameter N2PDFOPTION_ATTACHMENT_MODE kann bestimmt werden, wie der Anhang verarbeitet werden soll.
Welche Anhänge (Dateinamen) und aus welchen Feldern des Dokuments diese übernommen werden, bestimmen Sie über die Parameter <ItemName> und <AttachmentName> (siehe Beschreibung weiter unten).
|
Eine Liste der unterstützten Formate und welcher "Modus" je Dateiformat zur Verfügung steht, finden Sie im Dokument "Unterstützte Inhalte" und "Allgemeines" im Kapitel "Attachments". |
Deklaration für Lotus Script
Declare Function N2PDFAddAttachment Lib LibName ( ByVal JobID As Long,_
ByVal ContentType As Long, ByVal ContentOption As Long,_
ByVal ServerName As Unicode String, ByVal DatabaseName As Unicode String,_
ByVal UNID As Unicode String, ByVal ItemName As Unicode String,_
ByVal AttachmentName As Unicode String ) As Long
Parameter
<JobID> (LONG)
Die Nummer, die beim Aufruf von N2PDFInit zurückgeliefert wird und die die PDF-Datei im Hauptspeicher referenziert. Über diese ID steuern Sie, welche PDF-Datei Sie mit der Funktion ansprechen wollen.
<ContentType> (LONG)
Der Parameter hat keine Bedeutung mehr, da die Option N2PDFVALUE_ATTACHMENT_CONVERT_MODE nun eindeutig den benutzten Modus defniert. Setzen Sie den Parameter immer auf 0.
<ContentOption> (LONG)
Dieser Parameter hat nur dann eine Bedeutung, wenn Sie zur Verarbeitung von Dateianhängen den Import-Modus (N2PDFVALUE_ATTACHMENT_IMPORT_MODE) gesetzt haben. In diesem Fall können Sie einen Zeilen- oder Seitenumbruch vor oder nach dem Inhalt des Anhangs einfügen. Die Verwendung von mehreren Parametern gleichzeitig wird durch Addition der einzelnen Werte erreicht. Eine Auflistung der möglichen Werte können Sie der nachfolgenden Tabelle entnehmen:
<ContentOption> |
Beschreibung |
N2PDFVALUE_PAGEBREAK_AFTER |
Fügt einen Seitenumbruch nach dem Inhalt ein. |
N2PDFVALUE_PAGEBREAK_BEFORE |
Fügt einen Seitenumbruch vor dem Inhalt ein. |
N2PDFVALUE_CRLF_AFTER |
Fügt einen Zeilenumbruch nach dem Inhalt ein. |
N2PDFVALUE_CRLF_BEFORE |
Fügt einen Zeilenumbruch vor dem Inhalt ein. |
ServerName> (UNICODE STRING)
Dies ist der Server-Name, auf der sich die Datenbank befindet, die das RichText-Feld mit dem Anhang enthält. Liegt die Datenbank lokal (aus Sicht des Clients oder des Servers), dann geben Sie bitte "" als Wert an.
<DatabaseName> (UNICODE STRING)
Dies ist der Name der Datenbank, in der sich das RichText-Feld mit dem Anhang befindet. Bitte denken Sie daran, dass dieser Name unter Umständen auch einen Pfad enthalten muss, wenn die Datenbank in einem Unterverzeichnis des Notes-Data-Verzeichnisses liegt. Sie dürfen allerdings keine absoluten Pfadangaben („C:\Notes\Data\N2PDF\Test.nsf") verwenden, sondern immer nur relative zum Data-Verzeichnis des Clients bzw. Servers („N2PDF\Test.nsf").
<UNID> (UNICODE STRING)
Dies ist die „Universal Document ID" des RichText-Feldes.
<ItemName> (UNICODE STRING)
Geben Sie hier den Namen des RichText-Feldes an, das den Anhang enthält. Wenn Sie alle Anhänge eines Dokuments übergeben wollen egal in welchem Feld der Anhang gespeichert ist, dann übergeben Sie an dieser Stelle den Wert "".
<AttachmentName> (UNICODE STRING)
Wenn Sie einen bestimmte Anhang aus dem Dokument übergeben möchten, so geben Sie hier den Namen des Anhangs (z. B. "Bullshark.jpg") an. Geben Sie hier den Wert "" an, so werden alle Anhänge genommen, die in dem Feld <ItemName> vorhanden sind. Wenn Sie mehr als einen Anhang übergeben möchten, dann trennen Sie die verschiedenen Namen durch ein Semikolon ( z. B. "Bullshark.jpg;shark.jpg")
|
Wenn Sie <ItemName> und <AttachmentName> angeben, dann werden nur Anhänge übernommen, die in <AttachmentName> definiert sind und auch gleichzeitig in dem Feld <ItemName> liegen. |
Rückgabe
<ErrorCode> (LONG)
Nummer des Fehlers, der bei der Ausführung der Funktion aufgetreten ist (siehe „Fehlernummern ").
Beispiel: Alle Anhänge aus dem Feld "File" als Inhalt einfügen
Call N2PDFAddAttachment ( JobID,_
0,_
N2PDFVALUE_CRLF_BEFORE,_
db.Server,_
db.FilePath,_
doc.UniversalID,_
"File",_
"" )
Beispiel: Nur den Anhang "Bullshark.jpg" aus dem Feld "File" als Inhalt einfügen
Call N2PDFAddAttachment ( JobID,_
0,_
N2PDFVALUE_CRLF_BEFORE,_
db.Server,_
db.FilePath,_
doc.UniversalID,_
"File",_
"Bullshark.jpg" )
Beispiel: Alle Anhänge aus dem Feld "File" an das Ende der PDF-Datei anhängen
Call N2PDFAddAttachment ( JobID,_
0,_
N2PDFVALUE_CRLF_BEFORE,_
db.Server,_
db.FilePath,_
doc.UniversalID,_
"File",_
"" )