HashAlgorithm.TryHashFinal(Span<Byte>, Int32) Method

Reference

Definition

Namespace:: System.Security.Cryptography

Assembly:: System.Security.Cryptography.Primitives.dll

Assembly:: System.Security.Cryptography.dll

Assembly:: netstandard.dll

Source:: HashAlgorithm.cs

Source:: HashAlgorithm.cs

Source:: HashAlgorithm.cs

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.

Attempts to finalize the hash computation after the last data is processed by the hash algorithm.

protected:
 virtual bool TryHashFinal(Span<System::Byte> destination, [Runtime::InteropServices::Out] int % bytesWritten);

protected virtual bool TryHashFinal (Span<byte> destination, out int bytesWritten);

abstract member TryHashFinal : Span<byte> * int -> bool
override this.TryHashFinal : Span<byte> * int -> bool

Protected Overridable Function TryHashFinal (destination As Span(Of Byte), ByRef bytesWritten As Integer) As Boolean

Parameters

destination: Span<Byte>

The buffer to receive the hash value.

bytesWritten: Int32

When this method returns, the total number of bytes written into destination. This parameter is treated as uninitialized.

Returns

Boolean

true if destination is long enough to receive the hash value; otherwise, false.

Remarks

The default implementation of this method is to call HashFinal() and copy the result to destination.

Derived types should override this method to avoid the intermediate array creation.

All calls to this method by the HashAlgorithm class have already verified that destination is long enough based on the HashSize property, so false return values are unexpected.

Applies to

Share via