API: Destination

Table of Contents HPDF_Destination_SetXYZ() HPDF_Destination_SetFit() HPDF_Destination_SetFitH() HPDF_Destination_SetFitV() HPDF_Destination_SetFitR() HPDF_Destination_SetFitB() HPDF_Destination_SetFitBH() HPDF_Destination_SetFitBV()

HPDF_Destination_SetXYZ()

HPDF_STATUS HPDF_Destination_SetXYZ (HPDF_Destination  dst,
                                     HPDF_REAL         left,
                                     HPDF_REAL         top,
                                     HPDF_REAL         zoom);

Description

HPDF_Destination_SetXYZ() defines the appearance of a page with three parameters which are left, top and zoom.

Parameters

dst - The handle of a destination object.
left - The left coordinates of the page.
top - The top coordinates of the page.
zoom - The page magnified factor. The value must be between 0.08(8%) to 32(%).

Returns

When HPDF_Destination_SetXYZ() succeeds, it returns HPDF_OK. Otherwise, it returns error-code and error-handler is invoked.

Error codes

• HPDF_INVALID_DESTINATION - An invalid destination handle was set.
• HPDF_INVALID_PARAMETER - An invalid value was set at either left, top or zoom parameter.

HPDF_Destination_SetFit()

HPDF_STATUS HPDF_Destination_SetFit (HPDF_Destination dst);

Description

HPDF_Destination_Fit() sets the appearance of the page to displaying entire page within the window.

Parameters

page - The handle of a destination object.

Returns

When HPDF_Destination_SetFit() succeeds, it returns HPDF_OK. Otherwise, it returns error-code and error-handler is invoked.

Error codes

• HPDF_INVALID_DESTINATION - An invalid destination handle was set.

HPDF_Destination_SetFitH()

HPDF_STATUS HPDF_Destination_SetFitH (HPDF_Destination  dst,
                                      HPDF_REAL         top);

Description

HPDF_Destination_SetFitH() defines the appearance of a page to magnifying to fit the width of the page within the window and setting the top position of the page to the value of the "top" parameter.

Parameters

dst - The handle of a destination object.
top - The top coordinates of the pege.

Returns

When HPDF_Destination_SetFitH() succeeds, it returns HPDF_OK. Otherwise, it returns error-code and error-handler is invoked.

Error codes

• HPDF_INVALID_DESTINATION - An invalid destination handle was set.
• HPDF_INVALID_PARAMETER - An invalid value was set at either left, top or zoom parameter.

HPDF_Destination_SetFitV()

HPDF_STATUS HPDF_Destination_SetFitV  (HPDF_Destination  dst,
                                       HPDF_REAL         left);

Description

HPDF_Destination_SetFitV() defines the appearance of a page to magnifying to fit the height of the page within the window and setting the left position of the page to the value of the "top" parameter.

Parameters

dst - The handle of a destination object.
left - The left coordinates of the pege.

Returns

When HPDF_Destination_SetFitV() succeeds, it returns HPDF_OK. Otherwise, it returns error-code and error-handler is invoked.

Error codes

• HPDF_INVALID_DESTINATION - An invalid destination handle was set.
• HPDF_INVALID_PARAMETER - An invalid value was set at either left, top or zoom parameter.

HPDF_Destination_SetFitR()

HPDF_STATUS HPDF_Destination_SetFitR  (HPDF_Destination  dst,
                                       HPDF_REAL         left,
                                       HPDF_REAL         bottom,
                                       HPDF_REAL         right,
                                       HPDF_REAL         top);

Description

HPDF_Destination_SetFitR() defines the appearance of a page to magnifying the page to fit a rectangle specified by left, bottom, right and top.

Parameters

dst - The handle of a destination object.
left - The left coordinates of the page.
bottom - The bottom coordinates of the page.
right - The right coordinates of the page.
top - The top coordinates of the page.

Returns

When HPDF_Destination_SetR() succeeds, it returns HPDF_OK. Otherwise, it returns error-code and error-handler is invoked.

Error codes

• HPDF_INVALID_DESTINATION - An invalid destination handle was set.
• HPDF_INVALID_PARAMETER - An invalid value was set at either left, top or zoom parameter.

HPDF_Destination_SetFitB()

HPDF_STATUS HPDF_Destination_SetFitB (HPDF_Destination dst);

Description

HPDF_Destination_FitB() sets the appearance of the page to magnifying to fit the bounding box of the page within the window.

Parameters

dst - The handle of a destination object.

Returns

When HPDF_Destination_SetFitB() succeeds, it returns HPDF_OK. Otherwise, it returns error-code and error-handler is invoked.

Error codes

• HPDF_INVALID_DESTINATION - An invalid destination handle was set.

HPDF_Destination_SetFitBH()

HPDF_STATUS HPDF_Destination_SetFitBH  (HPDF_Destination  dst,
                                        HPDF_REAL         top);

Description

HPDF_Destination_SetFitBH() defines the appearance of a page to magnifying to fit the width of the bounding box of the page within the window and setting the top position of the page to the value of the "top" parameter.

Parameters

dst - The handle of a destination object.
top - The top coordinates of the pege.

Returns

When HPDF_Destination_SetFitBH() succeeds, it returns HPDF_OK. Otherwise, it returns error-code and error-handler is invoked.

Error codes

• HPDF_INVALID_DESTINATION - An invalid destination handle was set.
• HPDF_INVALID_PARAMETER - An invalid value was set at either left, top or zoom parameter.

HPDF_Destination_SetFitBV()

HPDF_STATUS HPDF_Destination_SetFitBV  (HPDF_Destination  dst,
                                        HPDF_REAL         top);

Description

HPDF_Destination_SetFitBV() defines the appearance of a page to magnifying to fit the height of the bounding box of the page within the window and setting the top position of the page to the value of the "top" parameter.

Parameters

dst - The handle of a destination object.
left - The left coordinates of the pege.

Returns

When HPDF_Destination_SetFitBV() succeeds, it returns HPDF_OK. Otherwise, it returns error-code and error-handler is invoked.

Error codes

• HPDF_INVALID_DESTINATION - An invalid destination handle was set.
• HPDF_INVALID_PARAMETER - An invalid value was set at either left, top or zoom parameter.