API: Outline

HPDF_Outline_SetOpened()

HPDF_STATUS HPDF_Outline_SetOpened  (HPDF_Outline  outline,
                                     HPDF_BOOL     opened);

Description

HPDF_Outline_SetOpened() sets whether this node is opened or not when the outline is displayed for the first time.

Parameters

outline - The handle of an outline object.
opened - Specify whether the node is opened or not.

Returns

When HPDF_Outline_SetOpened() succeed, it returns HPDF_OK. Otherwise it returns error code and an error-handler will be invoked.

Error codes

• HPDF_INVALID_OUTLINE - An invalid outline handle was set.
• HPDF_FAILD_TO_ALLOC_MEM - Memory allocation failed.

HPDF_Outline_SetDestination()

HPDF_STATUS HPDF_Outline_SetDestination (HPDF_Outline      outline,
                                         HPDF_Destination  dst);

Description

HPDF_Outline_SetDestination sets a destination object which becomes to a target to jump when the outline is clicked.

Parameters

outline - Specify the handle of an outline object.
dst - Specify the handle of an destination object.

Returns

When HPDF_Outline_SetDestination () succeed, it returns HPDF_OK. Otherwise it returns error code and an error-handler will be invoked.

Error codes

• HPDF_INVALID_OUTLINE - An invalid outline handle was set.
• HPDF_INVALID_DESTINATION - An invalid destination handle was set.
• HPDF_FAILD_TO_ALLOC_MEM - Memory allocation failed.