<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Add bookmark to current page</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.ps.html">PS Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ps-add-launchlink.html">ps_add_launchlink</a></div>
<div class="up"><a href="ref.ps.html">PS Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ps-add-bookmark" class="refentry">
<div class="refnamediv">
<h1 class="refname">ps_add_bookmark</h1>
<p class="verinfo">(PECL ps >= 1.1.0)</p><p class="refpurpose"><span class="refname">ps_add_bookmark</span> — <span class="dc-title">Add bookmark to current page</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ps-add-bookmark-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>ps_add_bookmark</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$psdoc</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$text</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$parent</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$open</code><span class="initializer"> = 0</span></span>
]] )</div>
<p class="para rdfs-comment">
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.
</p>
<p class="para">The note will not be visible if the document
is printed or viewed but it will show up if the document is converted to
pdf by either Acrobat Distiller™ or Ghostview.</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ps-add-bookmark-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">psdoc</code></em></span>
<dd>
<p class="para">
Resource identifier of the postscript file
as returned by <span class="function"><a href="function.ps-new.html" class="function">ps_new()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">text</code></em></span>
<dd>
<p class="para">
The text used for displaying the bookmark.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">parent</code></em></span>
<dd>
<p class="para">
A bookmark previously created by this function which
is used as the parent of the new bookmark.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">open</code></em></span>
<dd>
<p class="para">
If <em><code class="parameter">open</code></em> is unequal to zero the bookmark will
be shown open by the pdf viewer.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ps-add-bookmark-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
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.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ps-add-bookmark-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ps-add-launchlink.html" class="function" rel="rdfs-seeAlso">ps_add_launchlink()</a> - Adds link which launches file</span></li>
<li class="member"> <span class="function"><a href="function.ps-add-pdflink.html" class="function" rel="rdfs-seeAlso">ps_add_pdflink()</a> - Adds link to a page in a second pdf document</span></li>
<li class="member"> <span class="function"><a href="function.ps-add-weblink.html" class="function" rel="rdfs-seeAlso">ps_add_weblink()</a> - Adds link to a web location</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.ps.html">PS Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ps-add-launchlink.html">ps_add_launchlink</a></div>
<div class="up"><a href="ref.ps.html">PS Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
