ps_add_bookmark
(PECL ps:1.1.0-1.3.5)
ps_add_bookmark — Add bookmark to current page
Description
int ps_add_bookmark ( resource $psdoc , string $text [, int $parent [, int $open ]] )
The bookmark has no meaning if the document is printed or viewed, but it will be used if the document is converted to pdf by either Acrobat Distillerâ„¢ or Ghostview.
Parameters
- psdoc
-
Resource identifier of the postscript file as returned by ps_new().
- text
-
The text used for displaying the bookmark.
- parent
-
A bookmark previously created by this function which is used as the parent of the new bookmark.
- open
-
If open is unequal to zero the bookmark will be shown open by the pdf viewer.
Return Values
The returned value is a reference for the bookmark. It is only used if the bookmark shall be used as a parent. The value is greater zero if the function succeeds. In case of an error zero will be returned.