activePDF Toolkit 2011 API Reference
Obj_GetKind
Technical Reference
>
Explorer Object
>
Methods
> Obj_GetKind
Glossary Item Box
Obj_GetKind
Deprecated:
Use the
Val_HasStream
,
Val_IsArray
,
Val_IsDict
,
Val_IsNum
,
Val_IsRef
, and
Val_IsString
methods in cycle instead.
Description:
Determines the type of object or object value the object attribute value represents.
Syntax:
retValue =
object
.
Obj_GetKind
(
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
Dictionary
object as verified by the
Val_IsDict
method.
retValue:
Value Type
Description & Settings
Integer
A value used to determine whether the type of object or object value the
AttrVariant
represents. Available returns are:
-1
=
The
AttrVariant
is invalid.
0
=
The
AttrVariant
has a
Stream
value.
1
=
The
AttrVariant
represents an object
Array
.
2
=
The
AttrVariant
represents a
Dictionary
object.
3
=
The
AttrVariant
represents an
Integer
or
Real number
object.
4
=
The
AttrVariant
represents an object
Reference
.
5
=
The
AttrVariant
represents a
String
object.
