status = doc:AddPageLabel(pagenum, style, firstpage[, prefix])
doc:AddPageLabel()
adds a page labeling range for the document. The page label is shown
in the thumbnails view.
style
must be one of the following special constants:
#HPDF_PAGE_NUM_STYLE_DECIMAL:
#HPDF_PAGE_NUM_STYLE_UPPER_ROMAN:
#HPDF_PAGE_NUM_STYLE_LOWER_ROMAN:
#HPDF_PAGE_NUM_STYLE_UPPER_LETTERS:
#HPDF_PAGE_NUM_STYLE_LOWER_LETTERS:
When doc:AddPageLabel()
succeeds, it returns #HPDF_OK
. Otherwise, it returns an error code and the error handler is invoked.
#HPDF_INVALID_DOCUMENT
- An invalid document handle was set.
#HPDF_FAILED_TO_ALLOC_MEM
- Memory allocation failed.
#HPDF_PAGE_NUM_STYLE_OUT_OF_RANGE
- An invalid page numbering style is specified.