Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5    Statistic  

DynaPDF.DeleteEmbeddedFile

The function deletes an embedded file.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
DynaPDF 5.0 Yes Yes Yes Yes Yes

MBS( "DynaPDF.DeleteEmbeddedFile"; PDF; Handle )

Parameters

Parameter Description Example value
PDF The PDF reference returned from DynaPDF.New. $pdf
Handle The index number for the embedded file. Range from 0 to DynaPDF.GetEmbeddedFileCount. 0

Result

Returns OK or error.

Description

The function deletes an embedded file.
The parameter Handle must be a valid embedded file handle. Such a handle is a simple array index. DynaPDF.GetEmbeddedFileCount returns the remaining number of embedded files. If all embedded files should be deleted then delete the files from top to bottom by decrementing the loop variable. This is faster because it is not required to reorganize the array in which the files are stored in this case. All handles above the deleted file index become invalid after the file was deleted.

See also DeleteEmbeddedFile function in DynaPDF manual.

See also


DynaPDF.DeleteBookmark   -   DynaPDF.DeleteField

Feedback: Report problem or ask question.




Links
MBS Xojo PDF Plugins