Big-Data-HPC-Platform/docs/ECLStandardLibraryReference/SLR-Mods/ExcludeNthWord.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<sect1 id="ExcludeNthWord">
  <title>ExcludeNthWord</title>

  <para><emphasis role="bold">STD.Str.ExcludeNthWord<indexterm>
      <primary>STD.Str.ExcludeNthWord</primary>
    </indexterm><indexterm>
      <primary>Str.ExcludeNthWord</primary>
    </indexterm><indexterm>
      <primary>ExcludeNthWord</primary>
    </indexterm>(</emphasis> <emphasis>text, n</emphasis> <emphasis
  role="bold">)</emphasis></para>

  <informaltable colsep="0" frame="none" rowsep="0">
    <tgroup cols="2">
      <colspec colwidth="80.50pt" />

      <colspec />

      <tbody>
        <row>
          <entry><emphasis>text</emphasis></entry>

          <entry>A string containing words separated by whitespace.</entry>
        </row>

        <row>
          <entry><emphasis>n</emphasis></entry>

          <entry>A integer containing the ordinal position of the word to
          remove.</entry>
        </row>

        <row>
          <entry>Return:<emphasis> </emphasis></entry>

          <entry>ExcludeNthWord returns a STRING value.</entry>
        </row>
      </tbody>
    </tgroup>
  </informaltable>

  <para>The <emphasis role="bold">ExcludeNthWord </emphasis>function returns
  the <emphasis>text</emphasis> string with the <emphasis>n</emphasis>th word
  removed. Words are separated by one or more whitespace characters.
  Whitespace after the <emphasis>n</emphasis>th word is also removed (along
  with whitespace before, if <emphasis>n</emphasis>=1).</para>

  <para>Example:</para>

  <programlisting format="linespecific">A := STD.Str.ExcludeNthWord('The quick brown fox',2);
 //A contains 'The brown fox'
</programlisting>
</sect1>