0LASubrTextFindAndReplace < Main

---+ .TEXT FIND AND REPLACE

_This subroutine finds and replaces text in a text/alpha field._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;text_field&gt;               FIELD            SHARE? Y
      PASS         &lt;search_text&gt;              FIELD            SHARE? N
      PASS         &lt;replace_with&gt;             FIELD            SHARE? N
      PASS         &lt;no_of_replacements&gt;       FIELD            SHARE? Y
      PASS         &lt;skip&gt;                     FIELD            SHARE? N
      PASS         &lt;max_no_replace&gt;           FIELD            SHARE? N
      PASS         &lt;start_of_text&gt;            FIELD            SHARE? N
      PASS         &lt;len_of_text&gt;              FIELD            SHARE? N
      PASS         &lt;start_of_search&gt;          FIELD            SHARE? N
      PASS         &lt;len_of_search&gt;            FIELD            SHARE? N
      PASS         &lt;start_of_replace&gt;         FIELD            SHARE? N
      PASS         &lt;len_of_replace&gt;           FIELD            SHARE? N
      GOSUB    --- .TEXT FIND AND REPLACE
      *        Check for errors
      IF       --- .TEXT FIND AND REPLACE     NE

</pre>
---++ Description:

This subroutine finds and replaces text in a text/alpha field. The first 2 parameters are required. If any required parameters are missing, the subroutine will CANCEL.

&lt;text_field&gt; is the text to be modified (Required). This must be PASSed with Share "Y" to return the value.

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

&lt;replace_with&gt; is the replacement text (Optional). If not PASSed this routine will 'cut' the the &lt;search_text&gt; from &lt;text_field&gt;. This is different from PASSing a blank field, if you pass a blank field, then blanks will be inserted into &lt;text_field&gt;. The number of blanks will depend on the &lt;len_of_replace&gt; field below.

&lt;no_of_replacements&gt; returns the number of times the text was replaced (Optional). This must be PASSed with Share "Y" to return the value.

&lt;skip&gt; is the number of occurrences of &lt;search_text&gt; to skip before beginning replacement (Optional). If not PASSed, all occurrences will be replaced.

&lt;max_no_replace&gt; is the maximum number of replacements you want performed (Optional). If not PASSed or a blank/zero value is PASSed, all occurrences will be replaced. For example, if you only want the first 2 occurrences replaced, PASS 0 for &lt;skip&gt; and 2 for &lt;max_no_replace&gt;, or if you only want the 3rd & 4th occurrences replaced, PASS 2 for &lt;skip&gt; and 2 for &lt;max_no_replace&gt;. You can also PASS -1 to indicate all occurrences.

&lt;start_of_text&gt; is the starting position in &lt;text_field&gt; to begin the search (Optional). If not PASSed or a blank/zero value is PASSed, &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 PASSed or a blank/zero value is PASSed, &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.

&lt;start_of_replace&gt; is the starting position in &lt;replace_with&gt; to use (Optional). If not PASSed or a blank/zero value is PASSed, &lt;replace_with&gt; starting at position 1 will be used.

&lt;len_of_replace&gt; is the number of characters from &lt;start_of_replace&gt; to be used (Optional). If you PASS a zero or blank, &lt;search_text&gt; will be 'cut' from &lt;text_field&gt;. If not PASSed at all, &lt;replace_with&gt; will be used to the end of the field.

Notes:
   * 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-10
This topic: Main > WebHome > APPX510Features > APPXRuntimeSubroutineAPI > 0LASubrTextFindAndReplace
Topic revision: r4 - 2023-04-10 - BrianRyan