<?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-set-info.php',
    1 => 'ps_set_info',
    2 => 'ドキュメントの情報を設定する',
  ),
  'up' => 
  array (
    0 => 'ref.ps.php',
    1 => 'PS 関数',
  ),
  'prev' => 
  array (
    0 => 'function.ps-set-border-style.php',
    1 => 'ps_set_border_style',
  ),
  'next' => 
  array (
    0 => 'function.ps-set-parameter.php',
    1 => 'ps_set_parameter',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/ps/functions/ps-set-info.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ps-set-info" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ps_set_info</h1>
  <p class="verinfo">(PECL ps &gt;= 1.1.0)</p><p class="refpurpose"><span class="refname">ps_set_info</span> &mdash; <span class="dc-title">ドキュメントの情報を設定する</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ps-set-info-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ps_set_info</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">$key</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$value</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   ドキュメントの情報フィールドを設定します。この情報は、PostScript
   ファイルのヘッダにコメントとして表示されます。
   ドキュメントが pdf に変換された場合にも、
   このフィールドはドキュメントの情報として使用されます。
  </p>
  <p class="para">
   通常 <code class="literal">BoundingBox</code> は最初のページの設定と同じ値を
   設定しておきます。 <span class="function"><a href="function.ps-findfont.php" class="function">ps_findfont()</a></span>
   が事前に呼ばれていなかった場合のみ、この設定が利用されます。そのような場合、
   もしこの関数で明示的に設定していなければ BoundingBox は空白のままとなります。
  </p>
  <p class="para">
   postscript ファイルのヘッダが既に書き込まれている場合には、
   この関数は何の意味も持ちません。この関数は、最初のページの前、
   あるいは <span class="function"><a href="function.ps-findfont.php" class="function">ps_findfont()</a></span>
   が最初にコールされる前にコールされる必要があります。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ps-set-info-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">psdoc</code></dt>
     <dd>
      <p class="para">
       <span class="function"><a href="function.ps-new.php" class="function">ps_new()</a></span> が返す、postscript
       ファイルのリソース ID。
      </p>
     </dd>
    
    
     <dt><code class="parameter">key</code></dt>
     <dd>
      <p class="para">
       設定する情報フィールドの名前。設定できる値は
       <code class="literal">Keywords</code>、<code class="literal">Subject</code>、
       <code class="literal">Title</code>、<code class="literal">Creator</code>、
       <code class="literal">Author</code>、<code class="literal">BoundingBox</code> および
       <code class="literal">Orientation</code> です。
       このうちのいくつかは、PostScript
       ビューアに対して意味を持つものであることに注意しましょう。
      </p>
     </dd>
    
    
     <dt><code class="parameter">value</code></dt>
     <dd>
      <p class="para">
       情報フィールドの値。
       <code class="literal">Orientation</code> フィールドには
       <code class="literal">Portrait</code> あるいは <code class="literal">Landscape</code>
       が設定できます。<code class="literal">BoundingBox</code>
       は 4 つの数値からなる文字列で、最初の 2 つがページの左下角の座標を表します。
       残りの 2 つが右上角の座標です。
      </p>
      <blockquote class="note"><p><strong class="note">注意</strong>: 
       <p class="para">
        pslib のバージョン 0.2.6 まででは、
        <span class="function"><a href="function.ps-findfont.php" class="function">ps_findfont()</a></span> が事前にコールされていない限り、
        この関数は常に BoundingBox および Orientation を上書きします。
       </p>
      </p></blockquote>
     </dd>
    
   </dl>
  </p>
 </div>


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


 <div class="refsect1 seealso" id="refsect1-function.ps-set-info-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.ps-findfont.php" class="function" rel="rdfs-seeAlso">ps_findfont()</a> - フォントを読み込む</span></li>
    <li><span class="function"><a href="function.ps-begin-page.php" class="function" rel="rdfs-seeAlso">ps_begin_page()</a> - 新しいページを開始する</span></li>
   </ul>
  </p>
 </div>

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