StoreCustomDataFromFile

Dokumenteigenschaften

Beschreibung

Prüfen Sie Syntax, Parameter und Rückgabewerte, bevor Sie die Funktion aufrufen Die Codeblöcke bleiben im Original erhalten, damit Beispiele unverändert übernommen werden können.

Syntax

Delphi

Function TPDFlib.StoreCustomDataFromFile(Const Key, FileName: WideString; Location, Options: Integer): Integer;

ActiveX

Function PDFlib::StoreCustomDataFromFile(Key As String, FileName As String, Location As Long, Options As Long) As Long

DLL

int DLStoreCustomDataFromFile(int InstanceID, const wchar_t * Key, const wchar_t * FileName, int Location, int Options);

Parameter

KeyDer Schlüssel, unter dem die Daten gespeichert werden. Wenn der Speicherort das Document Information Dictionary ist, darf der Schlüssel nicht "Author", "Title", "Subject", "Keywords", "Creator" oder "Producer" lauten. Jeder andere Schlüssel kann verwendet werden; Schlüssel sollten jedoch sorgfältig gewählt werden, damit sie für den Benutzer verständlich sind. Wenn der Speicherort der Document Catalog ist, muss der Schlüssel ein spezielles, von Adobe zugewiesenes Präfix besitzen, um Konflikte mit anderer Software zu vermeiden.
FileNamePfad und Name der Datei mit den Daten, die unter dem angegebenen Schlüssel in der PDF gespeichert werden sollen.
Location1 = Daten im Document Information Dictionary speichern 2 = Daten im Document Catalog speichern
Options0 = Daten als Zeichenfolge speichern (die einzige verfügbare Option, wenn der Speicherort das Document Information Dictionary ist) 1 = Daten in einem Stream speichern 2 = Daten in einem komprimierten Stream speichern

Rückgabewerte

0Die Datei mit den Daten konnte nicht geöffnet werden oder der Parameter Key war ungültig
1Die Daten wurden erfolgreich gespeichert