ImageGear Professional v18.2 > API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > Page Editing Objects and Elements > HIG_PDE_CLIP > IG_PDE_clip_enumerate_elements |
For a given PDE Clip, enumerates all of the PDE Elements in a flattened manner.
Copy Code
|
|
---|---|
AT_ERRCOUNT ACCUAPI IG_PDE_clip_enumerate_elements ( HIG_PDE_CLIP hClip, LPFNIG_PDE_CLIP_ENUMPROC lpfnEnumProc, LPVOID lpClientData, LPAT_PDF_BOOL lpbResult ); |
Name | Type | Description |
hClip | HIG_PDE_CLIP | The PDEClip to enumerate. |
lpfnEnumProc | LPFNIG_PDE_CLIP_ENUMPROC | Called with each flattened element. Enumeration continues until all elements have been enumerated, or until lpfnEnumProc returns FALSE. |
lpClientData | LPVOID | Pointer to user-supplied data to pass to lpfnEnumProc each time it is called. |
lpbResult | LPAT_PDF_BOOL | Returns value of lpfnEnumProc. TRUE if successful; FALSE otherwise. |
Error count.
This function does not process image pixels.
PDE Containers and PDE Groups nested in the PDE Clip will not be handed back, but any PDE Paths and PDE Texts nested in them will be. Additionally, PDE Place objects inside the PDE Clip are not returned.