Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old


The function deletes an embedded file.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 5.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.DeleteEmbeddedFile"; PDF; Handle )   More


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


Returns OK or error.


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

This function checks for a license.

Created 6th February 2015, last changed 6th February 2015

DynaPDF.DeleteDPartNode - DynaPDF.DeleteField