RetrieveCustomDataToFile

Propiedades del documento

Descripción

Esta página documenta RetrieveCustomDataToFile en PDFlibPas dentro del tema Propiedades del documento. Los nombres de API, parámetros, clases, archivos y valores literales se conservan para coincidir con la biblioteca Delphi y sus puntos de entrada DLL.

Revise la sintaxis, los parámetros y los valores de retorno antes de llamar a la función. La página mantiene los bloques de código originales para que los ejemplos puedan copiarse sin cambios.

Sintaxis

Delphi

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

ActiveX

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

DLL

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

Parámetros

Key	`Key` es un parámetro de `RetrieveCustomDataToFile`. Use el tipo mostrado en la firma y proporcione un valor coherente con el documento PDF, la página seleccionada o el recurso activo.
FileName	`FileName` indica una ruta de archivo o un nombre de archivo. Use una ruta válida para el flujo de trabajo actual y conserve la codificación esperada por la API.
Location	`Location` es un parámetro de `RetrieveCustomDataToFile`. Use el tipo mostrado en la firma y proporcione un valor coherente con el documento PDF, la página seleccionada o el recurso activo.

Valores de retorno

0	Este valor describe el resultado de `RetrieveCustomDataToFile`. Como regla general, un valor distinto de cero indica éxito y 0 indica que la operación no se completó.
1	Este valor describe el resultado de `RetrieveCustomDataToFile`. Como regla general, un valor distinto de cero indica éxito y 0 indica que la operación no se completó.