ps_add_bookmark

PHP関数リファレンス

ps_add_bookmark

(PECL)
ps_add_bookmark — 現在のページにブックマークを追加する

説明

int ps_add_bookmark ( resource psdoc, string text [, int parent [, int open]] )
現在のページにブックマークを追加します。たいてい、ブックマークは PDFビューア上でページの左側にツリー形式で表示されます。 ブックマークをクリックすると、該当ページにジャンプします。
ドキュメントを印刷したり表示したりする場合にはブックマークは何の意味も 持ちません。ブックマークが使われるのは、Acrobat Distiller™ や Ghostview を用いてドキュメントを PDF に変換した場合です。

パラメータ

psdoc

ps_new() が返す、postscript ファイルのリソース ID。

text

ブックマークの表示に使用するテキスト。

parent

新しいブックマークの親となる、 事前にこの関数で作成されたブックマーク。

open

open がゼロでない場合、ブックマークは PDF ビューア上で開いた形で表示されます。

返り値

返り値はブックマークへの参照です。この値は、作成したブックマークを 他のブックマークの親として使用する場合にのみ使われます。 成功した場合には、この値はゼロより大きくなります。 エラーが発生した場合にはゼロを返します。

参考

ps_add_launchlink()

ps_add_pdflink()

ps_add_weblink()