0LASubrTextUpperToLower < Main

Tags: view all tags
---+ .TEXT UPPER TO LOWER

_This subroutine converts upper case to lower case in a text/alpha field._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;converted_text&gt;           FIELD            SHARE? Y
      PASS         &lt;original_text&gt;            FIELD            SHARE? N
      PASS         &lt;convert_flag&gt;             FIELD            SHARE? N
      PASS         &lt;len_original_text&gt;        FIELD            SHARE? N
      GOSUB    --- .TEXT UPPER TO LOWER
      *        Check for errors
      IF       --- .TEXT UPPER TO LOWER       NE


</pre>
---++ Description:

This subroutine converts upper case to lower case in a text/alpha field. The first 2 parameters are required. If any required parameters are missing, the subroutine will CANCEL.

&lt;converted_field&gt; returns the converted &lt;original_text&gt; (Required). This must be PASSed with Share "Y" to return the value.

&lt;original_text&gt; is are the characters you want converted (Required).

&lt;convert_flag&gt; controls how the characters will be converted (Optional). If PASSed, it must be one of:

   * All - convert every character to lower case.
   * Firstword - leave the first character of the first word upper case, convert the rest.
   * Allwords - leave the first character of the every word upper case, convert the rest.
If not PASSed, the default value is All.

&lt;len_original_text&gt; *Optional - Release 6.0 + higher only.* This is a optional performance enhancement to reduce the time required to perform the case conversion. You can PASS the maximum length you expect in &lt;original_text&gt;. For example, if your &lt;original_text&gt; field is 1M in size, but you know the data will never be longer than 22 characters, you can pass 22 in this field. If you PASS this field and your data is longer, it will be truncated to this length.

If you don't care about conserving the original data, you can pass the same field for both &lt;converted_field&gt; and &lt;original_text&gt;.

Also see [[0LASubrTextLowerToUpper][.TEXT LOWER TO UPPER]].

Note: 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
Topic revision: r4 - 2023-04-10 - BrianRyan