Skip to content

IGR_Get_Page_Hyperlinks

IGR_Get_Page_Hyperlinks copies references of page hyperlinks into the user supplied array. The caller can iterate over all the page hyperlinks by incrementing the Index parameter.

Prototype

IGR_LONG IGR_Get_Page_Hyperlinks (
    HPAGE Page,
    IGR_LONG Index,
    IGR_LONG* Count,
    IGR_Hyperlink* Items,
    Error_Control_Block* ISYSError);

Parameters

PageHandle: HPAGE

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

Index: IGR_LONG

Offset of the hyperlink to return, 0 based.

Count: Pointer to IGR_LONG

Prior to the call: Set to the number of IGR_Hyperlink structures pointed to by the Items buffer.

After the call: Returns the number of items copied into the Items buffer.

Items: Pointer to IGR_Hyperlink

Pointer to a user allocated array of IGR_Hyperlink structures to be filled.

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.

Sample code

Error_Control_Block Error;
IGR_LONG Capabilities, DocType, DocHandle, PageHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)
{
    IGR_LONG PageCount;
    if (IGR_Get_Page_Count(DocHandle, &PageCount, &Error) == IGR_OK)
    {
        for (IGR_LONG i = 0; i < PageCount; i++)
        {
            if (IGR_Open_Page(DocHandle, i, &PageHandle, &Error) == IGR_OK)
            {
                IGR_LONG HyperlinkCount = 0;
                IGR_Get_Page_Hyperlink_Count(PageHandle, &HyperlinkCount, &Error);

                for (IGR_LONG j = 0; j < HyperlinkCount; j++)
                {
                    IGR_LONG read = 1;
                    IGR_Hyperlink hyperlink;

                    if (IGR_Get_Page_Hyperlink(PageHandle, j, &read, &hyperlink,
                        &Error) == IGR_OK)
                    {
                        // ….
                    }
                }

                IGR_Close_Page(PageHandle, &ISYSError);
            }
        }
    }
}

See also