php-doc-en/reference/ps/functions/ps-get-parameter.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
<refentry xml:id="function.ps-get-parameter" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_get_parameter</refname>
  <refpurpose>Gets certain parameters</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</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>
   Gets several parameters which were directly set by
   <function>ps_set_parameter</function> 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 <function>ps_set_parameter</function>.
  </para>
  <para>
   The parameter <parameter>name</parameter> can have the following values.
  </para>
  <para>
   <variablelist>
    <varlistentry>
     <term><literal>fontname</literal></term>
     <listitem>
      <para>
       The name of the currently active font or the font whose
       identifier is passed in parameter <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>fontencoding</literal></term>
     <listitem>
      <para>
       The encoding of the currently active font.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>dottedversion</literal></term>
     <listitem>
      <para>
       The version of the underlying pslib library in the format
       &lt;major&gt;.&lt;minor&gt;.&lt;subminor&gt;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>scope</literal></term>
     <listitem>
      <para>
       The current drawing scope. Can be object, document, null, page,
       pattern, path, template, prolog, font, glyph.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>ligaturedisolvechar</literal></term>
     <listitem>
      <para>
       The character which dissolves a ligature. If your are using a font
       which contains the ligature `ff' and `|' is the char to dissolve the
       ligature, then `f|f' will result in two `f' instead of the ligature `ff'.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>imageencoding</literal></term>
     <listitem>
      <para>
       The encoding used for encoding images. Can be either
       <literal>hex</literal> or <literal>85</literal>. hex encoding
       uses two bytes in the postscript file each byte in the image.
       85 stand for Ascii85 encoding.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linenumbermode</literal></term>
     <listitem>
      <para>
       Set to <literal>paragraph</literal> if lines are numbered
       within a paragraph or <literal>box</literal> if they are
       numbered within the surrounding box.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linebreak</literal></term>
     <listitem>
      <para>
       Only used if text is output with <function>ps_show_boxed</function>.
       If set to <literal>true</literal> a carriage return will add a line
       break.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>parbreak</literal></term>
     <listitem>
      <para>
       Only used if text is output with <function>ps_show_boxed</function>.
       If set to <literal>true</literal> a carriage return will start
       a new paragraph.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>hyphenation</literal></term>
     <listitem>
      <para>
       Only used if text is output with <function>ps_show_boxed</function>.
       If set to <literal>true</literal> the paragraph will be hyphenated
       if a hypen dictionary is set and exists.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>hyphendict</literal></term>
     <listitem>
      <para>
       Filename of the dictionary used for hyphenation pattern.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>psdoc</parameter></term>
     <listitem>
      <para>
       Resource identifier of the postscript file
       as returned by <function>ps_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Name of the parameter.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>modifier</parameter></term>
     <listitem>
      <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.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the value of the parameter &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
-->