archived-doc-ja/reference/ps/functions/ps-get-parameter.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: takagi Status: ready -->
<refentry xml:id="function.ps-get-parameter" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_get_parameter</refname>
  <refpurpose>パラメータを取得する</refpurpose>
 </refnamediv>

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

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合にパラメータの値を、&return.falseforfailure;。
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ps_set_parameter</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->