Hash Component
Properties Methods Events Configuration Settings Errors
The Hash component allows you to compute a hash using various algorithms.
Syntax
nsoftware.IPWorksEncrypt.Hash
Remarks
The Hash component allows you to compute a hash using various algorithms including SHA1, SHA224, SHA256, SHA384, SHA512, MD2, MD4, MD5, RIPEMD160, MD5SHA1, HMACMD5, HMACSHA1, HMACSHA224, HMACSHA256, HMACSHA384, HMACSHA512, etc.
To begin, first select the algorithm you wish to use when computing the hash. Common choices include MD5 and SHA1. For a full list of supported algorithms see the Algorithm property.
Next specify the data to hash. The component will determine the source of the input based on which properties are set.
The order in which the input properties are checked are as follows:
When a valid source is found the search stops.Call the ComputeHash method to hash the data. The HashValue property will hold the computed hash. By default the hash value is hex encoded for ease of use, but you may disable this by setting EncodeHash to False.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| Algorithm | The algorithm used to create the hash. |
| EncodeHash | Whether the hash value is hex encoded. |
| HashValue | The hash value. |
| InputFile | The file to process. |
| InputMessage | The message to process. |
| Key | The secret key for the hash algorithm. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| ComputeHash | Computes a hash. |
| Config | Sets or retrieves a configuration setting . |
| HashBlock | Computes the hash value of specified data. |
| Reset | Resets the component. |
| SetInputStream | Sets the stream from which the component will read data to encrypt or decrypt. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| Progress | Fired as progress is made. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| HashSize | The size of the computed hash code, read-only. |
| SHA3Version | The version of the SHA3 implementation. |
| CodePage | The system code page used for Unicode to Multibyte translations. |