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

Glossary Item Box

Description: Determines whether the attributes value does or does not represent an Integer or Real number object.
Syntax: retValue = object.Val_IsNum (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.

retValue: Value Type Description & Settings
Integer A value used to determine whether the AttrVariant does or does not represent an Integer or Real number object. Available returns are:

0 = The AttrVariant does not represent an Integer or Real number object or is invalid.
1 = The AttrVariant represents an Integer or Real number object. The AttrVariant is suitable for passing to the Val_GetFloatVal method.

Remarks: This method is most effective when used in cycle with the Val_IsArray, Val_IsDict, Val_IsRef, and Val_IsString methods.