<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ps.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.ps-get-parameter.php',
    1 => 'ps_get_parameter',
    2 => 'パラメータを取得する',
  ),
  'up' => 
  array (
    0 => 'ref.ps.php',
    1 => 'PS 関数',
  ),
  'prev' => 
  array (
    0 => 'function.ps-get-buffer.php',
    1 => 'ps_get_buffer',
  ),
  'next' => 
  array (
    0 => 'function.ps-get-value.php',
    1 => 'ps_get_value',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/ps/functions/ps-get-parameter.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ps-get-parameter" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ps_get_parameter</h1>
  <p class="verinfo">(PECL ps &gt;= 1.1.0)</p><p class="refpurpose"><span class="refname">ps_get_parameter</span> &mdash; <span class="dc-title">パラメータを取得する</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ps-get-parameter-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ps_get_parameter</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$psdoc</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$name</code></span>, <span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$modifier</code><span class="initializer"> = ?</span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

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


 <div class="refsect1 returnvalues" id="refsect1-function.ps-get-parameter-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   成功した場合にパラメータの値を、失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.ps-get-parameter-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.ps-set-parameter.php" class="function" rel="rdfs-seeAlso">ps_set_parameter()</a> - パラメータを設定する</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>