activePDF Toolkit 2011 API Reference
Val_GetDict
Technical Reference
>
Explorer Object
>
Methods
> Val_GetDict
Glossary Item Box
Description:
Returns an encoded value for object attributes value known to represent an
Dictionary
object.
Syntax:
"retValue" =
object
.
Val_GetDict
(
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
An encoded value representing a
Dictionary
suitable for passing as the
DictObject
for the following methods:
Dict_GetAttrVal
Dict_GetName
Dict_GetValue
The method returns a 0 (
zero
) if the
AttrVariant
does not represent a
Dictionary
object or is invalid.
