DL Logo

PDEElements Functions

PDEEnumElements

Header: PERProcs.h:1528

Description

Enumerates all the PDEElements in a given stream. It is similar to PDEContentCreateFromCosObj(), but provides enumeration instead of a list of elements.

If marked content is not ignored, each PDEContainer contains a PDEContent list within itself.

Syntax

void PDEEnumElements(IN const CosObj *contents, IN const CosObj *resources, IN ASUns32 flags, IN PDEElementEnumProc enumProc, IN void *enumProcClientData);

Parameters

contents
IN/OUT A Cos object that is the source for the content stream. It may be page contents, a Form XObject, a Type 3 font CharProc, or an appearance object from an annotation.
resources
IN/OUT The object's Resources dictionary. If the Form or Type 3 font or appearance dictionary contains a Resources dictionary, this dictionary must be passed in resources. Otherwise, it must be the page resources object of the page containing the Form or Type 3 font contents object.
flags
IN/OUT Flags from PDEEnumElementsFlags.
enumProc
IN/OUT A user-supplied callback to call once for each top-level element. Note that the element in enumProc may only be valid for this method. Use PDEAcquire() if you need to hold on to the element longer than the scope of enumProc.
enumProcClientData
IN/OUT A pointer to user-supplied data to pass to enumProc each time it is called.

Exceptions