0LASubrTextToUnicode < Main

Tags: view all tags
---+ .TEXT TO UNICODE

This subroutine transcodes a RAW alpha field to a Unicode field. Added in 6.0.0

<br />%TOC%
---++ Usage
<pre>      PASS         &lt;unicode_field&gt;            FIELD            SHARE? Y
      PASS         &lt;source_text&gt;              FIELD            SHARE? N
      PASS         &lt;encoding&gt;                 FIELD            SHARE? N
      PASS         &lt;error_text&gt;               FIELD            SHARE? Y
      GOSUB    --- .TEXT TO UNICODE
      *        Check for errors
      IF       --- .TEXT TO UNICODE           NE
</pre>

---++ Description

This subroutine will transcode a RAW alpha field to a Unicode field. The first 2 parameters are required. If any required parameters are missing, the subroutine will CANCEL.

&lt;unicode_field&gt; is the Unicode field to receive the transcoded text (Required). This must be PASSed with Share "Y" to return the value.

&lt;source_text&gt; is the field containing the string to be transcoded (Required).

&lt;encoding&gt; identifies the encoding of the &lt;source_text&gt;. If not specified or a blank is PASSed, it will check the environment variable APPX_RAW_ENCODING and use that encoding. If that is not present, it will default to ISO-8859-15.

&lt;error text&gt; if an error occured this field contains additional error text from the Unicode library (Optional). This must be PASSed with Share "Y" to return the value.

<span style="background-color: transparent;">Notes:</span>
   * Normally this routine is not required as a simple SET from a RAW alpha to a Unicode field will automatically transcode it (using the APPX_RAW_ENCODING or the default ISO-8859-15 if not specified). If your source data is not in that encoding, then this routine can be used to transcode from the correct encoding.
   * 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

<br />%COMMENT%

-- %USERSIG{JeanNeron - 2017-11-02}%
Topic revision: r2 - 2023-04-10 - BrianRyan