activePDF Toolkit 2011 API Reference
GetRootObject
Technical Reference > Explorer Object > Methods > GetRootObject

Glossary Item Box

Description: Returns the root object's ID for the input PDF.
Syntax: retValue = object.GetRootObject
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the Explorer object.
retValue: Value Type Description & Settings
Integer The root object???s ID for the input PDF suitable for passing as the GetObject method's ObjectIDNumber argument.
Remarks: The root object is the first object in the object hierarchy for which the remaining objects are nodes or sub-nodes. Knowing the root object allows you to parse through the remaining objects in their hierarchical order. The method returns a 0 (zero) if the input PDF or ObjectIDNumber is invalid.