StoreCustomDataFromFile

Propiedades del documento

Descripción

Guarda datos personalizados de un archivo en el PDF bajo un nombre de clave. Estos datos pueden recuperarse posteriormente con RetrieveCustomDataToString o RetrieveCustomDataToFile. Se pueden establecer el tipo de almacenamiento (cadena, flujo o flujo comprimido) y la ubicación (Document Information Dictionary o Document Catalog). Si la ubicación es Document Catalog se puede usar cualquier tipo de almacenamiento, pero la clave debe tener un prefijo especial asignado por Adobe. Si la ubicación es Document Information Dictionary se puede usar cualquier clave excepto las claves estándar, pero solo se pueden usar cadenas

Sintaxis

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);

Parámetros

Key	La clave bajo la cual se almacenarán los datos. Si la ubicación es el Document Information Dictionary, la clave no puede ser "Author", "Title", "Subject", "Keywords", "Creator" ni "Producer". Se puede usar cualquier otra clave, pero debe elegirse con cuidado para que tenga sentido para el usuario. Si la ubicación es el Document Catalog, la clave debe tener un prefijo especial asignado por Adobe para evitar conflictos con otro software
FileName	La ruta y el nombre del archivo que contiene los datos que se almacenarán en el PDF con la clave especificada
Location	1 = Almacenar los datos en el diccionario de información del documento 2 = Almacenar los datos en el catálogo del documento
Options	0 = Almacenar los datos como cadena (la única opción disponible si la ubicación es el Document Information Dictionary) 1 = Almacenar los datos en un flujo 2 = Almacenar los datos en un flujo comprimido

Valores devueltos

0	No se pudo abrir el archivo que contiene los datos o el parámetro Key no era válido
1	Los datos se almacenaron correctamente