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

Glossary Item Box

Description: Returns an encoded value representing the first element of an object attributes value known to be an object Array.
Syntax: retValue = object.Val_GetFirstElem (AttrVariant)
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the Explorer object.
AttrVariant Integer An encoded value representing the input object's attributes as returned by the Dict_GetAttrVal, Dict_GetValue, Obj_AttrVal, Val_GetFirstElem, or Val_GetNextElem method known to be an object Array as verified by the Val_IsArray method.
retValue: Value Type Description & Settings
Integer An encoded value representing the first array element suitable for passing as the AttrVariant for the following methods: The method returns a 0 (zero) if the AttrVariant does not represent an object Array.

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