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

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: evvc Status: ready -->
<!-- Reviewed: no -->
<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>.
      </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' приведёт к двум `f' вместо лигатуры `ff'.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>imageencoding</literal></term>
     <listitem>
      <para>
       Кодировка, используемая для кодирования изображений. Может иметь значение <literal>hex</literal>
       или <literal>85</literal>. Шестнадцатеричное кодирование использует два байта
       в файле postscript на каждый байт изображения. 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="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>psdoc</parameter></term>
     <listitem>
      <para>
       Идентификатор ресурса файла postscript,
       возвращённый функцией <function>ps_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Имя параметра.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>modifier</parameter></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
-->