IGR_Enum_Page_Elements¶
IGR_Enum_Page_Elements recursively walks the page elements of source calling the user-supplied callback.
Prototype¶
IGR_RETURN_CODE IGR_Enum_Page_Elements(
IGR_HPAGE page,
const struct IGR_Page_Element* source,
IGR_ULONG flags,
IGR_ULONG max_depth,
IGR_PAGE_ELEMENT_CALLBACK callback,
void* context,
Error_Control_Block* error
)
Parameters¶
page: IGR_HPAGE
Page element containing the page elements to extract.
source: Pointer to IGR_Page_Element
The element of the element where the styles should be extracted.
flags: IGR_ULONG
Reserved for future use.
max_depth: IGR_ULONG
The maximum depth of page elements to walk.
callback: IGR_PAGE_ELEMENT_CALLBACK
User supplied callback where the element information is to be sent.
context: Pointer to void
User supplied callback context to pass when calling {callback}.
error: Pointer to Error_Control_Block
Returns error details if the call fails.
Return value¶
Success: IGR_LONG
Returns IGR_OK.
Failure: IGR_LONG
Returns one of the possible IGR_E error codes.