CapyKit/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_SHA256Hash.md
Jordan Wages 735d7c4c91 Documentation + Unfinished SecurityHelper
Committing the unfinished changes to the SecurityHelper as I flesh it out during the migration. Also starting a documentation folder powered by Sandcastle.
2024-04-19 23:12:24 -05:00

52 lines
1.1 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# SHA256Hash Method
Produces a <a href="https://en.wikipedia.org/wiki/SHA-2">SHA256</a> hash from a given *value*.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d
**C#**
``` C#
public static byte[] SHA256Hash(
string value
)
```
**VB**
``` VB
Public Shared Function SHA256Hash (
value As String
) As Byte()
```
**C++**
``` C++
public:
static array<unsigned char>^ SHA256Hash(
String^ value
)
```
**F#**
``` F#
static member SHA256Hash :
value : string -> byte[]
```
#### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The value.</dd></dl>
#### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]
A byte array equal to the SHA256 hash of *value* or an empty array if it fails.
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a>