activePDF Toolkit 2011 API Reference
Val_GetStreamLength
Technical Reference
>
Explorer Object
>
Methods
> Val_GetStreamLength
Glossary Item Box
Description:
Returns the number of characters contained in the stream for an object attributes value known to have a stream.
Syntax:
retValue =
object
.
Val_GetStreamLength
(
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 have a
Stream
value as verified by the
Val_HasStream
method.
retValue:
Value Type
Description & Settings
Integer
The number of characters contained in the stream for the object corresponding to the
AttrVariant
. The method returns a 0
zero
for a zero length stream or if the
AttrVariant
is invalid.
