Share via


VerifyFileHash Class

Definition

Verifies that a file matches the expected file hash.

public ref class VerifyFileHash sealed : Microsoft::Build::Tasks::TaskExtension
public ref class VerifyFileHash sealed : Microsoft::Build::Tasks::TaskExtension, Microsoft::Build::Framework::ICancelableTask
public sealed class VerifyFileHash : Microsoft.Build.Tasks.TaskExtension
public sealed class VerifyFileHash : Microsoft.Build.Tasks.TaskExtension, Microsoft.Build.Framework.ICancelableTask
type VerifyFileHash = class
    inherit TaskExtension
type VerifyFileHash = class
    inherit TaskExtension
    interface ICancelableTask
    interface ITask
Public NotInheritable Class VerifyFileHash
Inherits TaskExtension
Public NotInheritable Class VerifyFileHash
Inherits TaskExtension
Implements ICancelableTask
Inheritance
VerifyFileHash
Implements

Constructors

VerifyFileHash()

Properties

Algorithm

The hashing algorithm to use. Allowed values: SHA256, SHA384, SHA512. Default = SHA256.

BuildEngine

The build engine automatically sets this property to allow tasks to call back into it.

(Inherited from Task)
BuildEngine2

The build engine automatically sets this property to allow tasks to call back into it. This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2.

(Inherited from Task)
BuildEngine3

Retrieves the IBuildEngine3 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine4

Retrieves the IBuildEngine4 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine5

Retrieves the IBuildEngine5 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine6

Retrieves the IBuildEngine6 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine7

Retrieves the IBuildEngine7 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine8

Retrieves the IBuildEngine8 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine9

Retrieves the IBuildEngine9 version of the build engine interface provided by the host.

(Inherited from Task)
File

The file path.

Hash

The expected hash of the file.

HashEncoding

The encoding format of Hash. Defaults to "hex".

HelpKeywordPrefix

Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method.

(Inherited from Task)
HostObject

The build engine sets this property if the host IDE has associated a host object with this particular task.

(Inherited from Task)
Log

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.

(Inherited from TaskExtension)
TaskResources

Gets or sets the task's culture-specific resources. Derived classes should register their resources either during construction, or via this property, if they have localized strings.

(Inherited from Task)

Methods

Cancel()
Execute()

Applies to