IGR_Get_Page_Elements¶

IGR_Get_Page_Elements fills the dest buffer with dest_count page elements from the parent object, starting from the first index. If parent is NULL, the root element is copied into dest.

Prototype¶

IGR_RETURN_CODE IGR_Get_Page_Elements(
    IGR_HPAGE page, 
    const struct IGR_Page_Element* parent, 
    IGR_ULONG first, 
    IGR_ULONG* dest_count, 
    struct IGR_Page_Element* dest, 
    Error_Control_Block* error);

Parameters¶

page: HPAGE

Handle to a page, opened by a call to IGR_Open_Page.

parent: *IGR_Page_Element

Pointer to parent element, or NULL to retrieve elements for the root of the page.

first: IGR_ULONG

Index of first element to extract.

dest_count: *IGR_ULONG

Must set to size of dest array when calling. Will be set to number of elements populated on return.

dest: *IGR_Page_Element

Pointer to dest_count array of IGR_Page_Element. On input, the first elements struct_size must be set. On output, the structures are filled with element data.

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.

See also¶

• IGR_Page_Element Struct
• IGR_PAGE_ELEMENT_TYPE