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

Glossary Item Box

Description: Returns an encoded value representing the object's attributes for an object known to be a Dictionary object.
Syntax: retValue = object.Dict_GetValue (DictObject, iCount)
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the Explorer object.
DictObject Integer An encoded value representing a Dictionary object as returned by the Dict_GetDict method.
iCount Integer A value related to the level of the object in the hierarchy. Set this to (zero) during the first generation of the object cycle, and 1 (one) the iCount for subsequent generations.
retValue: Value Type Description & Settings
Integer An encoded value representing the Dictionary object's attributes suitable for passing as the AttrVariant for the following methods: The method returns a 0 (zero) if the DictObject is invalid or the iCount is incorrect.

NOTE: The required AttrVariant changes based on its location in the object parsing cycle started from the GetRootObject call.