0LASubrTextFind < Main

---+ .TEXT FIND

_This subroutine finds the position of text in a text/alpha field._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;text_position&gt;            FIELD            SHARE? Y
      PASS         &lt;text_field&gt;               FIELD            SHARE? N
      PASS         &lt;search_text&gt;              FIELD            SHARE? N
      PASS         &lt;start_of_text&gt;            FIELD            SHARE? N
      PASS         &lt;len_of _text&gt;             FIELD            SHARE? Y
      PASS         &lt;start_of_search&gt;          FIELD            SHARE? N
      PASS         &lt;len_of _search&gt;           FIELD            SHARE? Y
      GOSUB    --- .TEXT FIND
      *        Check for errors
*     IF       --- .TEXT FIND                 NE

</pre>
---++ Description:

This subroutine finds the position of text in a text/alpha field. The first 3 parameters are required. If any required parameters are missing, the subroutine will CANCEL.

&lt;text_position&gt; returns the position of &lt;search_text&gt; within &lt;text_field&gt; (Required). This must be PASSed with Share "Y" to return the value.

&lt;text_field&gt; is the text to be searched (Required).

&lt;search_text&gt; is the text to be searched for (Required).

&lt;start_of_text&gt; is the starting position in &lt;text_field&gt; to begin the search (Optional). If not provided, &lt;text_field&gt; will be searched starting at position 1.

&lt;len_of_text&gt; is the number of characters from &lt;start_of_text&gt; to be searched (Optional). If not provided, &lt;text_field&gt; will be searched to the end of the field.

&lt;start_of_search&gt; is the starting position in &lt;search_text&gt; to use (Optional). If not provided, &lt;search_text&gt; starting at position 1 will be used.

&lt;len_of_search&gt; is the number of characters from &lt;start_of_search&gt; to be used (Optional). If not provided, &lt;search_text&gt; will be used to the end of the field.

Notes:
   * The &lt;text_position&gt; returned is always from the start of &lt;text_field&gt;, even if you only searched a substring of &lt;text_field&gt;.
   * This is a case sensitive search, regular expressions are not allowed.
   * This subroutine is designed to operate on Alpha, Text, and Token fields only. The returned results are undefined if you specify any other type of field.
---++ Comments:

_Read what other users have said about this page or add your own comments._

<br />%COMMENT%

-- Main.JeanNeron - 2012-02-09
This topic: Main > WebHome > APPX510Features > APPXRuntimeSubroutineAPI > 0LASubrTextFind
Topic revision: r3 - 2023-04-10 - BrianRyan