doc:CreateOutline

Name

doc:CreateOutline -- create outline object

Synopsis

otl = doc:CreateOutline(parent, title, encoder)

Function

doc:CreateOutline() creates a new outline object.

When doc:CreateOutline() succeeds, it returns the handle of created outline object. Otherwise, it returns Nil and the error handler is invoked.

Inputs

parent: the handle of an outline object which comes to the parent of the created outline object; if Nil, the outline is created as a root outline
title: the caption of the outline object
encoder: the handle of an encoding object applied to the title; if Nil, the document's encoding is used

Results

Errors

#HPDF_INVALID_DOCUMENT - An invalid document handle was set.

#HPDF_FAILED_TO_ALLOC_MEM - Memory allocation failed.

#HPDF_INVALID_OUTLINE - An invalid parent outline is specified.