PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Notes
  • Availability of algorithms
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Calculates the Hash of a file according to a specific algorithm. You have the ability to calculate:
  • a simple hash.
  • a hash with message authentication.
Reminder: The hashing is used to summarize a file or a character string. This summary is called Hash.
Versions 15 and later
PHP This function is now available for the PHP sites.
Java This function is now available for the Java applications.
Android This function is now available for the Android applications.
New in version 15
PHP This function is now available for the PHP sites.
Java This function is now available for the Java applications.
Android This function is now available for the Android applications.
PHP This function is now available for the PHP sites.
Java This function is now available for the Java applications.
Android This function is now available for the Android applications.
Versions 17 and later
iPhone/iPad This function is now available for the iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for the iPhone/iPad applications.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Versions 18 and later
Universal Windows 10 App This function is now available in Windows Store apps mode.
Android Widget This function is now available in Android Widget mode.
New in version 18
Universal Windows 10 App This function is now available in Windows Store apps mode.
Android Widget This function is now available in Android Widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Android Widget This function is now available in Android Widget mode.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Example
WINDEVWEBDEV - Server codeReports and QueriesAjaxUser code (UMC)
// Calculate the Hash of two files
Hash1 is Buffer = HashFile(HA_MD5_128, "C:\My files\FileA.txt")
Hash2 is Buffer = HashFile(HA_MD5_128, "D:\My files\FileB.txt")
// Compare the two Hash
IF Hash1 = Hash2 THEN Info("The two files are identical.")
Windows Mobile
// Calculate the Hash of two files
Hash1 is Buffer = HashFile(HA_MD5_128, "\My files\FileA.txt")
Hash2 is Buffer = HashFile(HA_MD5_128, "\My files\FileB.txt")
// Compare the two Hash
IF Hash1 = Hash2 THEN Info("The two files are identical.")
Syntax

Calculating a simple hash Hide the details

<Result> = HashFile(<Type of Algorithm> , <File Path>)
<Result>: Buffer
Result of <File Path> hashing with the <Type of Algorithm> algorithm.
Caution: This result may contain non-displayable characters.
<Type of Algorithm>: Integer constant
Indicates the type of algorithm used when hashing the <File Path> file:
MD5 familyHA_MD5_128
SHA familyHA_SHA_160 (also called SHA-1)
HA_SHA_256
HA_SHA_384
HA_SHA_512
Versions 23 and later
SHA-3 family
New in version 23
SHA-3 family
SHA-3 family
Versions 23 and later
HA_SHA3_224
AndroidAndroid Widget JavaPHP Not available.
New in version 23
HA_SHA3_224
AndroidAndroid Widget JavaPHP Not available.
HA_SHA3_224
AndroidAndroid Widget JavaPHP Not available.
Versions 23 and later
HA_SHA3_256
AndroidAndroid Widget JavaPHP Not available.
New in version 23
HA_SHA3_256
AndroidAndroid Widget JavaPHP Not available.
HA_SHA3_256
AndroidAndroid Widget JavaPHP Not available.
Versions 23 and later
HA_SHA3_384
AndroidAndroid Widget JavaPHP Not available.
New in version 23
HA_SHA3_384
AndroidAndroid Widget JavaPHP Not available.
HA_SHA3_384
AndroidAndroid Widget JavaPHP Not available.
Versions 23 and later
HA_SHA3_512
AndroidAndroid Widget JavaPHP Not available.
New in version 23
HA_SHA3_512
AndroidAndroid Widget JavaPHP Not available.
HA_SHA3_512
AndroidAndroid Widget JavaPHP Not available.
RIPEMD familyHA_RIPEMD_128
AndroidAndroid Widget Java Not available.
HA_RIPEMD_160
AndroidAndroid Widget Java Not available.
TIGER familyHA_TIGER_128
AndroidAndroid Widget JavaPHP Not available.
AndroidAndroid Widget Java Not available.
HA_TIGER_160
AndroidAndroid Widget JavaPHP Not available.
AndroidAndroid Widget Java Not available.
HA_TIGER_192
AndroidAndroid Widget JavaPHP Not available.
AndroidAndroid Widget Java Not available.
WHIRLPOOL familyHA_WHIRLPOOL
AndroidAndroid Widget Java Not available.
CKSUM familyHA_CKSUM_8
AndroidAndroid Widget Java Not available.
HA_CKSUM_16
AndroidAndroid Widget Java Not available.
HA_CKSUM_32
AndroidAndroid Widget Java Not available.
HA_CKSUM_64
AndroidAndroid Widget Java Not available.
  • MD5/SHA/RIPEMD algorithms: standard cryptographic hash functions.
  • TIGER/WHIRLPOOL algorithms: hash functions with high cryptographic properties optimized for the 64-bit mode (but can also be used in 32-bit mode).
    PHP The TIGER algorithms are not available.
  • CKSUM algorithms: hash functions with no cryptographic property, should be used to perform low-level checks or with hashing tables.
<File Path>: Character string (with quotes)
Path of file on which the calculation will be performed.

Calculating a hash with message authentication (HMAC algorithm) Hide the details

<Result> = HashFile(<Type of Algorithm> , <File Path> , <Secret Key>)
<Result>: Buffer
Result of <File Path> hashing with the <Type of Algorithm> algorithm.
Caution: This result may contain non-displayable characters.
<Type of Algorithm>: Integer constant
Indicates the type of HMAC algorithm used when hashing the <File Path> file:
MD5 familyHA_HMAC_MD5_128
SHA familyHA_HMAC_SHA_160
HA_HMAC_SHA_256
HA_HMAC_SHA_384
HA_HMAC_SHA_512
Versions 23 and later
SHA-3 family
New in version 23
SHA-3 family
SHA-3 family
Versions 23 and later
HA_SHA3_224
AndroidAndroid Widget JavaPHP Not available.
New in version 23
HA_SHA3_224
AndroidAndroid Widget JavaPHP Not available.
HA_SHA3_224
AndroidAndroid Widget JavaPHP Not available.
Versions 23 and later
HA_SHA3_256
AndroidAndroid Widget JavaPHP Not available.
New in version 23
HA_SHA3_256
AndroidAndroid Widget JavaPHP Not available.
HA_SHA3_256
AndroidAndroid Widget JavaPHP Not available.
Versions 23 and later
HA_SHA3_384
AndroidAndroid Widget JavaPHP Not available.
New in version 23
HA_SHA3_384
AndroidAndroid Widget JavaPHP Not available.
HA_SHA3_384
AndroidAndroid Widget JavaPHP Not available.
Versions 23 and later
HA_SHA3_512
AndroidAndroid Widget JavaPHP Not available.
New in version 23
HA_SHA3_512
AndroidAndroid Widget JavaPHP Not available.
HA_SHA3_512
AndroidAndroid Widget JavaPHP Not available.
RIPEMD familyHA_HMAC_RIPEMD_128
AndroidAndroid Widget Java Not available.
HA_HMAC_RIPEMD_160
AndroidAndroid Widget Java Not available.
TIGER familyHA_HMAC_TIGER_128
AndroidAndroid Widget JavaPHP Not available.
AndroidAndroid Widget Java Not available.
HA_HMAC_TIGER_160
AndroidAndroid Widget JavaPHP Not available.
AndroidAndroid Widget Java Not available.
HA_HMAC_TIGER_192
AndroidAndroid Widget JavaPHP Not available.
AndroidAndroid Widget Java Not available.
WHIRLPOOL familyHA_HMAC_WHIRLPOOL
AndroidAndroid Widget Java Not available.
  • MD5/SHA/RIPEMD algorithms: standard cryptographic hash functions.
  • TIGER/WHIRLPOOL algorithms: hash functions with high cryptographic properties optimized for the 64-bit mode (but can also be used in 32-bit mode).
    PHP The TIGER algorithms are not available.
<File Path>: Character string (with quotes)
Path of file on which the calculation will be performed.
<Secret Key>: Character string (with quotes)
Authentication key of message.
AndroidAndroid Widget Java This parameter must not be an empty string.
Remarks

Notes

  • Two files with an identical content will have, for the same type of algorithm, two identical Hashes.
  • The result of the Hash may contain non-displayable characters. These characters will not be visible when using Info or Trace for example.

Availability of algorithms

PHP
  • The available algorithms depend on the configuration of the PHP server.
  • The TIGER algorithms are not available.The SHA-3 algorithms are not available.
AndroidAndroid Widget Java Only the following algorithms are supported:
  • HA_MD5_128
  • HA_SHA_160, HA_SHA_256, HA_SHA_384, HA_SHA_512
  • HA_HMAC_MD5_128
  • HA_ HMAC_SHA_160, HA_HMAC_SHA_256, HA_HMAC_SHA_384, HA_SHA_HMAC_512.
Related Examples:
The Hash functions Unit examples (WINDEV): The Hash functions
[ + ] Using the hashing functions.
The HashFile and HashString functions are used to calculate a Hash key for a string or for a file.
This Hash key is used to:
- Check whether the file is consistent after a transfer for example
- Find file duplicates
- ...
Components
WINDEVWEBDEV - Server codeReports and Queries wd230com.dll
Windows Mobile wp230com.dll
Java wd230java.jar
Linux wd230com.so
Android wd230android.jar
See also
Minimum required version
  • Version 11
This page is also available for…
Comments
Wrong hash Algorithm in example
// Calculate the Hash of two files
Hash1 is Buffer = HashFile(HA_MD5_128,"C:\My files\FileA.txt")
Hash2 is Buffer = HashFile(HA_MD5_128,"D:\My files\FileB.txt")
// Compare the two Hashes
IF Hash1 = Hash2 THEN Info("The two files are identical.")
Riebens
Feb. 12 2012