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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ed710737ea7ce93f1289809cf89170c6d48b72a6 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->
<!-- 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>Obtener ciertos parámetros</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>
   Obtiene varios parámetros que se establecieron directamente con la función
   <function>ps_set_parameter</function> o indirectamente por alguna de las otras
   funciones. Los parámetros son por definición valores de tipo
   string. Esta función no se puede usar para recuperar recursos que también fueron
   establecidos con la función <function>ps_set_parameter</function>.
  </para>
  <para>
   El parámetro <parameter>name</parameter> puede tener los siguientes valores:
  </para>
  <para>
   <variablelist>
    <varlistentry>
     <term><literal>fontname</literal></term>
     <listitem>
      <para>
       El nombre de la fuente activa o la fuente cuyo
       identificador es pasado al parámetro <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>fontencoding</literal></term>
     <listitem>
      <para>
       La codificación de la fuente activa.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>dottedversion</literal></term>
     <listitem>
      <para>
       La versión de la biblioteca pslib subyacente con el formato
       &lt;mayor&gt;.&lt;menor&gt;.&lt;submenor&gt;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>scope</literal></term>
     <listitem>
      <para>
       El ámbito de dibujo actual. Puede ser un objeto, un documento, null, una página,
       un patrón, un trazado, una plantilla, un prólogo, una fuente, un glifo.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>ligaturedisolvechar</literal></term>
     <listitem>
      <para>
       El carácter que disuelve una ligadura. Si se está utilizando una fuente
       que contiene la ligadura 'ff' y '|' es el carácter para disolver la
       ligadura, 'f|f' resultará en 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 imágenes. Puede ser
       <literal>hex</literal> o <literal>85</literal>. La codificación hex
       usa dos bytes en el fichero postscript por cada byte de la imagen.
       85 representa la codificación Ascii85.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linenumbermode</literal></term>
     <listitem>
      <para>
       Establecer a <literal>paragraph</literal> si las líneas están numeradas
       dentro de un párrafo, o <literal>box</literal> si están
       numeradas dentro de una caja circundante.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linebreak</literal></term>
     <listitem>
      <para>
       Se usa solamente si el texto se imprime con la función <function>ps_show_boxed</function>.
       Si se establece a &true; un retorno de carro añadirá un salto
       de línea.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>parbreak</literal></term>
     <listitem>
      <para>
       Se usa solamente si el texto se imprime con la función <function>ps_show_boxed</function>.
       Si se establece a &true; un retorno de carro iniciará
       un nuevo párrafo.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>hyphenation</literal></term>
     <listitem>
      <para>
       Se usa solamente si el texto se imprime con la función <function>ps_show_boxed</function>.
       Si se establece a &true; el párrafo será dividido mediante guiones
       si está establecido y existe un diccionario de partición silábica.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>hyphendict</literal></term>
     <listitem>
      <para>
       Nombre de fichero del diccionario usado como patrón de partición silábica.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>psdoc</parameter></term>
     <listitem>
      <para>
       El identificador de recursos del fichero postscript,
       como el devuelto por la función <function>ps_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       El nombre del parámetro.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>modifier</parameter></term>
     <listitem>
      <para>
       Un identificador necesario si se solicita un parámetro de un recurso,
       p.ej. el tamaño de una imagen. En tal caso se pasa el ID del
       recurso.
      </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
-->