ps_set_info

(PECL ps >= 1.1.0)

ps_set_infoドキュメントの情報を設定する

説明

ps_set_info(resource $p, string $key, string $val): bool

ドキュメントの情報フィールドを設定します。この情報は、PostScript ファイルのヘッダにコメントとして表示されます。 ドキュメントが pdf に変換された場合にも、 このフィールドはドキュメントの情報として使用されます。

通常 BoundingBox は最初のページの設定と同じ値を 設定しておきます。 ps_findfont() が事前に呼ばれていなかった場合のみ、この設定が利用されます。そのような場合、 もしこの関数で明示的に設定していなければ BoundingBox は空白のままとなります。

postscript ファイルのヘッダが既に書き込まれている場合には、 この関数は何の意味も持ちません。この関数は、最初のページの前、 あるいは ps_findfont() が最初にコールされる前にコールされる必要があります。

パラメータ

psdoc

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

key

設定する情報フィールドの名前。設定できる値は KeywordsSubjectTitleCreatorAuthorBoundingBox および Orientation です。 このうちのいくつかは、PostScript ビューアに対して意味を持つものであることに注意しましょう。

value

情報フィールドの値。 Orientation フィールドには Portrait あるいは Landscape が設定できます。BoundingBox は 4 つの数値からなる文字列で、最初の 2 つがページの左下角の座標を表します。 残りの 2 つが右上角の座標です。

注意:

pslib のバージョン 0.2.6 まででは、 ps_findfont() が事前にコールされていない限り、 この関数は常に BoundingBox および Orientation を上書きします。

戻り値

成功した場合に true を、失敗した場合に false を返します。

参考

関連キーワード:  設定, 情報, フィールド, BoundingBox, ドキュメント, 関数, findfont, 最初, ページ, Orientation