ps_get_parameter
(PECL)
ps_get_parameter — パラメータを取得する
ps_set_parameter() で直接設定されたか、 あるいは他の関数で間接的に設定されたパラメータの値を取得します。 パラメータは文字列値として定義されます。この関数は、 同じく ps_set_parameter() で設定されたリソースを取得するためには利用できません。
パラメータ name は、以下の値をとります。
ps_get_parameter — パラメータを取得する
説明
string ps_get_parameter ( resource psdoc, string name [, float modifier] )ps_set_parameter() で直接設定されたか、 あるいは他の関数で間接的に設定されたパラメータの値を取得します。 パラメータは文字列値として定義されます。この関数は、 同じく ps_set_parameter() で設定されたリソースを取得するためには利用できません。
パラメータ name は、以下の値をとります。
- fontname
- 現在アクティブなフォント、 あるいはパラメータ modifier で指定された ID を持つフォントの名前。
- fontencoding
- 現在アクティブなフォントのエンコーディング。
- dottedversion
- 元になる pslib ライブラリのバージョン。書式は <major>.<minor>.<subminor>
- scope
- 現在の描画スコープ。object, document, null, page, pattern, path, template, prolog, font, glyph。
- ligaturedisolvechar
- リゲチャを溶かす文字。たとえば、リゲチャ `ff' を含むフォントで `|' がこの文字に指定されていた場合は、 `f|f' はリゲチャ `ff' ではなく 2 つの独立した `f' となります。
- imageencoding
- 画像の符号化に使用するエンコーディング。 hex あるいは 85。 hex エンコーディングは、画像の各バイトを postscript ファイルの 2 バイトであらわします。85 は Ascii85 エンコーディングを表します。
- linenumbermode
- 行番号を段落単位でつける場合は paragraph、 ボックス内でつける場合は box を設定します。
- linebreak
- テキストを ps_show_boxed() で出力する場合にのみ使用します。 true を設定すると、 改行時にキャリッジリターンが付加されます。
- parbreak
- テキストを ps_show_boxed() で出力する場合にのみ使用します。 true を設定すると、 キャリッジリターンで新しい段落を開始します。
- hyphenation
- テキストを ps_show_boxed() で出力する場合にのみ使用します。 true を設定すると、 ハイフネーション辞書が設定されており存在する場合に、 段落のハイフネーション処理が行われます。
- hyphendict
- ハイフネーションパターンの辞書のファイル名。
返り値
成功した場合にパラメータの値を、エラー時には FALSE を返します。参考
ps_set_parameter() |
- ps_get_parameterのページへのリンク