 | PdfiumFPDF_GetRoot Method |
Get the catalog dictionary for the PDF document contained in the file.
Namespace: Patagames.PdfAssembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.94.2704
Syntaxpublic static IntPtr FPDF_GetRoot(
IntPtr document
)
Public Shared Function FPDF_GetRoot (
document As IntPtr
) As IntPtr
public:
static IntPtr FPDF_GetRoot(
IntPtr document
)
static member FPDF_GetRoot :
document : IntPtr -> IntPtr
public static IntPtr FPDF_GetRoot(
IntPtr document
)
Patagames.Pdf.Pdfium.FPDF_GetRoot = function(document);
Parameters
- document IntPtr
- Handle to document. Returned by FPDF_LoadDocument(String, String) function.
Return Value
IntPtrHandle to the PDF dictionary
Remarks
The root of a document’s object hierarchy is the catalog dictionary, located by
means of the Root entry in the trailer of the PDF file.
The catalog contains references to other objects defining the
document’s contents, outline, article threads(PDF 1.1), named destinations, and
other attributes.In addition, it contains information about how the document
should be displayed on the screen, such as whether its outline and thumbnail
page images should be displayed automatically and whether some location other
than the first page should be shown when the document is opened.
See Also