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

Glossary Item Box

Description: Returns the numerical value for an object attributes value known to represent a Integer or Real number object.
Syntax: retValue = object.Val_GetFloatVal (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 a Integer or Real number object as verified by the Val_IsNum method.

retValue: Value Type Description & Settings
Integer The numerical value contained in the Integer or Real number object corresponding to the AttrVariant. The method returns a 0 zero if the value is 0 or if the AttrVariant is invalid.