activePDF Toolkit 2011 API Reference
Val_GetStreamChars
Technical Reference
>
Explorer Object
>
Methods
> Val_GetStreamChars
Glossary Item Box
Description:
Returns the data found between the
stream
and
endstream
keywords for an object attributes value known to have a stream.
Syntax:
"retValue" =
object
.
Val_GetStreamChars
(
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
String
The data found between the
stream
and
endstream
keywords for the object attributes value. The method returns an empty string (
""
) for a zero length stream or if the
AttrVariant
is invalid.
