archived-doc-es/reference/ps/functions/ps-get-parameter.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.ps-get-parameter" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_get_parameter</refname>
  <refpurpose>Recupera ciertos parámetros</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>
   Recupera varios parámetros que han sido establecidos directamente por
   <function>ps_set_parameter</function> o indirectamente por una o más
   funciones. Los parámetros son, por definición,
   valores de &string;. Esta función no puede ser utilizada para
   recuperar los recursos que también han sido establecidos por
   <function>ps_set_parameter</function>.
  </para>
  <para>
   El parámetro <parameter>name</parameter> puede tener una de las siguientes
   valores.
  </para>
  <para>
   <variablelist>
    <varlistentry>
     <term><literal>fontname</literal></term>
     <listitem>
      <para>
       El nombre de la fuente actualmente activa o la fuente cuyo identificador
       es pasado en el parámetro <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>fontencoding</literal></term>
     <listitem>
      <para>
       La codificación de la fuente actualmente activa.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>dottedversion</literal></term>
     <listitem>
      <para>
       La versión de la biblioteca subyacente pslib en el formato
       &lt;mayor&gt;.&lt;menor&gt;.&lt;submenor&gt;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>scope</literal></term>
     <listitem>
      <para>
       El ámbito actual del dibujo. Puede ser un objeto, un documento, &null;,
       una página, un patrón, un camino, un modelo, un prólogo, una fuente, un
       glifo.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>ligaturedisolvechar</literal></term>
     <listitem>
      <para>
       El carácter que descompone una ligadura. Si se utiliza una fuente que
       contiene una ligadura `ff' y `|` es el carácter para descomponer la
       ligadura, entonces `f|f' dará dos `f' en lugar de la ligadura `ff'.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>imageencoding</literal></term>
     <listitem>
      <para>
       La codificación utilizada para codificar las imágenes. Puede ser
       <literal>hex</literal> o <literal>85</literal>. La codificación hex utiliza
       dos octetos en el archivo PostScript, cada octeto en una imagen.
       85 representa la codificación Ascii85.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linenumbermode</literal></term>
     <listitem>
      <para>
       Se establece en <literal>paragraph</literal> si las líneas son numeradas
       dentro de un párrafo o <literal>box</literal> si son numeradas en una
       caja que las rodea.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linebreak</literal></term>
     <listitem>
      <para>
       Solo utilizado si el texto es mostrado con
       <function>ps_show_boxed</function>. Si se establece en &true;, un retorno
       de carro añadirá un salto de línea.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>parbreak</literal></term>
     <listitem>
      <para>
       Solo utilizado si el texto es mostrado con
       <function>ps_show_boxed</function>. Si se establece en &true;, un retorno
       de carro iniciará un nuevo párrafo.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>hyphenation</literal></term>
     <listitem>
      <para>
       Solo utilizado si el texto es mostrado con
       <function>ps_show_boxed</function>. Si se establece en &true;, el párrafo
       será dividido si un diccionario de guiones es establecido y existe.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>hyphendict</literal></term>
     <listitem>
      <para>
       Nombre del archivo del diccionario utilizado para el patrón de guiones.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>psdoc</parameter></term>
     <listitem>
      <para>
       Identificador de un archivo postscript devuelto por
       <function>ps_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Nombre del parámetro.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>modifier</parameter></term>
     <listitem>
      <para>
       Un identificador requerido si el parámetro de un recurso es requerido,
       por ejemplo, el tamaño de una imagen. En este caso, el identificador del
       recurso es pasado.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve el valor del parámetro &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
-->