HMACSHA1.HashDataAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| HashDataAsync(Byte[], Stream, CancellationToken) |
Asynchronously computes the HMAC of a stream using the SHA1 algorithm. |
| HashDataAsync(ReadOnlyMemory<Byte>, Stream, CancellationToken) |
Asynchronously computes the HMAC of a stream using the SHA1 algorithm. |
| HashDataAsync(ReadOnlyMemory<Byte>, Stream, Memory<Byte>, CancellationToken) |
Asynchronously computes the HMAC of a stream using the SHA1 algorithm. |
HashDataAsync(Byte[], Stream, CancellationToken)
- Source:
- HMACSHA1.cs
- Source:
- HMACSHA1.cs
- Source:
- HMACSHA1.cs
Asynchronously computes the HMAC of a stream using the SHA1 algorithm.
public static System.Threading.Tasks.ValueTask<byte[]> HashDataAsync (byte[] key, System.IO.Stream source, System.Threading.CancellationToken cancellationToken = default);static member HashDataAsync : byte[] * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<byte[]>Public Shared Function HashDataAsync (key As Byte(), source As Stream, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Byte())Parameters
- key
- Byte[]
The HMAC key.
- source
- Stream
The stream to HMAC.
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests. The default value is None.
Returns
The HMAC of the data.
Exceptions
key or source is null.
source does not support reading.
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by HashData(Byte[], Stream).
Applies to
HashDataAsync(ReadOnlyMemory<Byte>, Stream, CancellationToken)
- Source:
- HMACSHA1.cs
- Source:
- HMACSHA1.cs
- Source:
- HMACSHA1.cs
Asynchronously computes the HMAC of a stream using the SHA1 algorithm.
public static System.Threading.Tasks.ValueTask<byte[]> HashDataAsync (ReadOnlyMemory<byte> key, System.IO.Stream source, System.Threading.CancellationToken cancellationToken = default);static member HashDataAsync : ReadOnlyMemory<byte> * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<byte[]>Public Shared Function HashDataAsync (key As ReadOnlyMemory(Of Byte), source As Stream, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Byte())Parameters
- key
- ReadOnlyMemory<Byte>
The HMAC key.
- source
- Stream
The stream to HMAC.
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests. The default value is None.
Returns
The HMAC of the data.
Exceptions
source is null.
source does not support reading.
The cancellation token was canceled. This exception is stored into the returned task.
Applies to
HashDataAsync(ReadOnlyMemory<Byte>, Stream, Memory<Byte>, CancellationToken)
- Source:
- HMACSHA1.cs
- Source:
- HMACSHA1.cs
- Source:
- HMACSHA1.cs
Asynchronously computes the HMAC of a stream using the SHA1 algorithm.
public static System.Threading.Tasks.ValueTask<int> HashDataAsync (ReadOnlyMemory<byte> key, System.IO.Stream source, Memory<byte> destination, System.Threading.CancellationToken cancellationToken = default);static member HashDataAsync : ReadOnlyMemory<byte> * System.IO.Stream * Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>Public Shared Function HashDataAsync (key As ReadOnlyMemory(Of Byte), source As Stream, destination As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)Parameters
- key
- ReadOnlyMemory<Byte>
The HMAC key.
- source
- Stream
The stream to HMAC.
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests. The default value is None.
Returns
The total number of bytes written to destination.
Exceptions
source is null.
The buffer in destination is too small to hold the calculated hash
size. The SHA1 algorithm always produces a 160-bit hash, or 20 bytes.
-or-
source does not support reading.
The cancellation token was canceled. This exception is stored into the returned task.
