ps_add_bookmark

Add bookmark to current page

&reftitle.description; `int` `ps_add_bookmark` `resource` `psdoc` `string` `text` `int` `parent` 0 `int` `open` 0

Adds a bookmark for the current page. Bookmarks usually appear in PDF-Viewers left of the page in a hierarchical tree. Clicking on a bookmark will jump to the given page.

&ps.note.visible;
&reftitle.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.

&reftitle.returnvalues;

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.

&reftitle.seealso;

- `ps_add_launchlink`
- `ps_add_pdflink`
- `ps_add_weblink`