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

BinaryFile.ReadPDF

Reads data as PDF.

Component Version macOS Windows Linux Server iOS SDK
BinaryFile 7.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "BinaryFile.ReadPDF"; BinaryFileRef; ByteCount { ; Filename } )   More

Parameters

Parameter Description Example Flags
BinaryFileRef The reference number for the open file. $FH
ByteCount The number of Bytes to read. 1000
Filename Optional file name to use for PDF in container value. "test.pdf" Optional

Result

Returns PDF, empty or error.

Description

Reads data as PDF.
This is a special method which actually reads the data and then looks inside the data for a PDF.
So there can be data before and after the PDF, which is ignored.
Returns nothing if no PDF is found.

For PDF content: If you have a DynaPDF Pro license and DynaPDF functions initialized, this function can add previews for the PDF file on Windows and Linux. For MacOS, we make them with PDFKit.

Examples

Read some PDF from file:

Set Variable [ $fh ; Value: MBS( "BinaryFile.Open"; "/Users/cs/Desktop/Tes0059.pdf" ) ]
Set Variable [ $len ; Value: MBS( "BinaryFile.Length"; $fh) ]
Set Variable [ $pdf ; Value: MBS( "BinaryFile.ReadPDF"; $fh; $len; "test.pdf") ]
Set Field [ test::ContainerField ; $pdf ]
Set Variable [ $r ; Value: MBS( "BinaryFile.Close"; $fh) ]

See also

Release notes

Blog Entries

This function checks for a license.

Created 12nd June 2017, last changed 27th October 2019


BinaryFile.ReadInt - BinaryFile.ReadText