<?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 => 'it',
  ),
  'this' => 
  array (
    0 => 'function.ps-get-parameter.php',
    1 => 'ps_get_parameter',
    2 => 'Gets certain parameters',
  ),
  'up' => 
  array (
    0 => 'ref.ps.php',
    1 => 'PS Funzioni',
  ),
  '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' => 'en',
    '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">Gets certain parameters</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ps-get-parameter-description">
  <h3 class="title">Descrizione</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">
   Gets several parameters which were directly set by
   <span class="function"><a href="function.ps-set-parameter.php" class="function">ps_set_parameter()</a></span> or indirectly by one of the other
   functions. Parameters are by definition string
   values. This function cannot be used to retrieve resources which were also
   set by <span class="function"><a href="function.ps-set-parameter.php" class="function">ps_set_parameter()</a></span>.
  </p>
  <p class="para">
   The parameter <code class="parameter">name</code> can have the following values.
  </p>
  <p class="para">
   <dl>
    
     <dt><code class="literal">fontname</code></dt>
     <dd>
      <p class="para">
       The name of the currently active font or the font whose
       identifier is passed in parameter <code class="parameter">modifier</code>.
      </p>
     </dd>
    
    
     <dt><code class="literal">fontencoding</code></dt>
     <dd>
      <p class="para">
       The encoding of the currently active font.
      </p>
     </dd>
    
    
     <dt><code class="literal">dottedversion</code></dt>
     <dd>
      <p class="para">
       The version of the underlying pslib library in the format
       &lt;major&gt;.&lt;minor&gt;.&lt;subminor&gt;
      </p>
     </dd>
    
    
     <dt><code class="literal">scope</code></dt>
     <dd>
      <p class="para">
       The current drawing scope. Can be object, document, null, page,
       pattern, path, template, prolog, font, glyph.
      </p>
     </dd>
    
    
     <dt><code class="literal">ligaturedisolvechar</code></dt>
     <dd>
      <p class="para">
       The character which dissolves a ligature. If your are using a font
       which contains the ligature `ff&#039; and `|&#039; is the char to dissolve the
       ligature, then `f|f&#039; will result in two `f&#039; instead of the ligature `ff&#039;.
      </p>
     </dd>
    
    
     <dt><code class="literal">imageencoding</code></dt>
     <dd>
      <p class="para">
       The encoding used for encoding images. Can be either
       <code class="literal">hex</code> or <code class="literal">85</code>. hex encoding
       uses two bytes in the postscript file each byte in the image.
       85 stand for Ascii85 encoding.
      </p>
     </dd>
    
    
     <dt><code class="literal">linenumbermode</code></dt>
     <dd>
      <p class="para">
       Set to <code class="literal">paragraph</code> if lines are numbered
       within a paragraph or <code class="literal">box</code> if they are
       numbered within the surrounding box.
      </p>
     </dd>
    
    
     <dt><code class="literal">linebreak</code></dt>
     <dd>
      <p class="para">
       Only used if text is output with <span class="function"><a href="function.ps-show-boxed.php" class="function">ps_show_boxed()</a></span>.
       If set to <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> a carriage return will add a line
       break.
      </p>
     </dd>
    
    
     <dt><code class="literal">parbreak</code></dt>
     <dd>
      <p class="para">
       Only used if text is output with <span class="function"><a href="function.ps-show-boxed.php" class="function">ps_show_boxed()</a></span>.
       If set to <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> a carriage return will start
       a new paragraph.
      </p>
     </dd>
    
    
     <dt><code class="literal">hyphenation</code></dt>
     <dd>
      <p class="para">
       Only used if text is output with <span class="function"><a href="function.ps-show-boxed.php" class="function">ps_show_boxed()</a></span>.
       If set to <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> the paragraph will be hyphenated
       if a hypen dictionary is set and exists.
      </p>
     </dd>
    
    
     <dt><code class="literal">hyphendict</code></dt>
     <dd>
      <p class="para">
       Filename of the dictionary used for hyphenation pattern.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ps-get-parameter-parameters">
  <h3 class="title">Elenco dei parametri</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">psdoc</code></dt>
     <dd>
      <p class="para">
       Resource identifier of the postscript file
       as returned by <span class="function"><a href="function.ps-new.php" class="function">ps_new()</a></span>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">name</code></dt>
     <dd>
      <p class="para">
       Name of the parameter.
      </p>
     </dd>
    
    
     <dt><code class="parameter">modifier</code></dt>
     <dd>
      <p class="para">
       An identifier needed if a parameter of a resource is requested,
       e.g. the size of an image. In such a case the resource id is
       passed.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ps-get-parameter-returnvalues">
  <h3 class="title">Valori restituiti</h3>
  <p class="para">
   Returns the value of the parameter  o <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> in caso di fallimento.
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.ps-get-parameter-seealso">
  <h3 class="title">Vedere anche:</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> - Sets certain parameters</span></li>
   </ul>
  </p>
 </div>

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