GetEmbeddedFileContentToFile

Document properties

Description

Extracts the specified embedded file and writes the content to the specified file.

Syntax

Delphi

function TPDFlib.GetEmbeddedFileContentToFile(Index: Integer; Const FileName: WideString): Integer;

ActiveX

Function PDFlib::GetEmbeddedFileContentToFile(Index As Long, FileName As String) As Long

DLL

int DLGetEmbeddedFileContentToFile(int InstanceID, int Index, wchar_t * FileName);

Parameters

IndexThe index of the embedded file. Must be a value between 1 and the value returned by EmbeddedFileCount.
FileNameThe path and file name of the file to write the contents to.

Return values

0Could not write to the specified file or Index parameter was invalid. Embedded file contents written to the specified file successfully.
1