archived-doc-es/reference/mbstring/functions/mb-substr.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d4d54d7bb6cdbb3ccd52b9d40d488ee01c38cae3 Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xml:id="function.mb-substr" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_substr</refname>
  <refpurpose>Obtiene parte de una cadena de caracteres</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mb_substr</methodname>
   <methodparam><type>string</type><parameter>str</parameter></methodparam>
   <methodparam><type>int</type><parameter>start</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>NULL</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>mb_internal_encoding()</initializer></methodparam>
  </methodsynopsis>
  <para>
   Realiza una operación 
   <function>substr</function> multibyte de forma segura basada
   en el número de caracteres. La posición se cuenta
   desde el principio de
   <parameter>str</parameter>. La posición del primer carácter es
   0. La posición del segundo es 1, etc. 
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>str</parameter></term>
     <listitem>
      <para>
       El <type>string</type> de donde extraer la parte deseada.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>start</parameter></term>
     <listitem>
      <para>
       Si <parameter>start</parameter> no es negativo, el string devuelto
       comenzará en la posición <parameter>start</parameter>-ésima de
       <parameter>string</parameter>, empezando desde cero. Por ejemplo,
       en el string '<literal>abcdef</literal>', el carácter en la
       posición <literal>0</literal> es '<literal>a</literal>', el
       carácter en la posición <literal>2</literal> es
       '<literal>c</literal>', etc.
      </para>
      <para>
       Si <parameter>start</parameter> es negative, el string devuelto
       comenzará en el <parameter>start</parameter>-ésimo carácter
       desde el final de <parameter>string</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       El número máximo de caracteres a usar de <parameter>str</parameter>. Si
       se omite o se pasa <literal>NULL</literal>, extrae todos los caracteres
       hasta el final del string.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      &mbstring.encoding.parameter;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>mb_substr</function> devuelve una parte de
   <parameter>str</parameter> especificada por los parametros
   <parameter>start</parameter> y
   <parameter>length</parameter>.
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.4.8</entry>
       <entry>
        Pasar <literal>NULL</literal> al parámetro <parameter>length</parameter>
        extrae todos los caracteres hasta el final de string. Antes de esta versión,
        <literal>NULL</literal> era tratado de igual modo que <literal>0</literal>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mb_strcut</function></member>
    <member><function>mb_internal_encoding</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
-->