0LASubrUtilComputeHash < Main

Tags: view all tags
---+ .UTIL COMPUTE HASH

_This subroutine computes the SHA-2 hash value for the given string. APPX 5.4.5 & higher only._

<br />%TOC%
---++ Usage:
<pre>*     PASS         &lt;hash value returned&gt;      FIELD            SHARE? Y
*     PASS         &lt;hash type&gt;                FIELD            SHARE? N
*     PASS         &lt;Data to hash&gt;             FIELD            SHARE? N
*     PASS         &lt;Unicode flag&gt;             FIELD            SHARE? N
*     GOSUB    --- .UTIL COMPUTE HASH
      *        Check for errors
*     IF       --- .UTIL COMPUTE HASH         NE
</pre>
---++ Description:

This subroutine computes the SHA-2 hash value for the given string. The first 2 parameters are required and if any required parameters are missing, the subroutine will CANCEL.

&lt;hash value returned&gt; is the computed value returned. This must be passed with Share="Y" to return a value. It should be an alpha field at least 64 or 128 bytes in length, depending on the &lt;hash type&gt; requested (Required).

&lt;hash type&gt; is the type of hash value you want returned (Required):
   * BIN for a 64 byte binary value
   * UC for a 128 byte readable value, upper case
   * LC for a 128 byte readable value, lower case
&lt;Data to hash&gt; is the string to be hashed (32k max size).

&lt;Unicode flag&gt; Pass UNI if you want the calculation performed on a Unicode field (optional, Release 6.0 and higher only). For compatibility with release 5, the hash calculation is performed on a RAW field. PASSing a unicode field in &lt;Data to hash&gt; that contains characters that cannot be transcoded to the RAW encoding will result in a runtime error. To force the calculation to be performed on the Unicode field, pass UNI for &lt;Unicode flag&gt;. Note that since RAW and Unicode fields have different internal structures, passing the same string with and without the &lt;Unicode Flag&gt; will return different hash values.
---++ Comments:

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

Editorial comment: This API provides a great way to overcome the APPX 256-character key length limitation. If your desired key is a field longer than 256 (such as a server file path or a group of many fields), or if it will be longer than 256 when the primary key is appended, pass the desired key value into this subroutine and use the resulting 128-byte value as your guaranteed unique key.

-- %BUBBLESIG{AlKalter - 2016-11-07}%<br />%COMMENT%

-- Main.JeanNeron - 2012-03-08
Topic revision: r4 - 2017-12-04 - JeanNeron