Untar Class

Definition

Namespace:

Microsoft.Build.Tasks

Assembly:

Microsoft.Build.Tasks.Core.dll

Package:

Microsoft.Build.Tasks.Core v18.11.0

Source:

Untar.cs

Represents a task that can extract a tar archive, optionally compressed with GZip or ZStandard.

public ref class Untar sealed : Microsoft::Build::Tasks::TaskExtension, Microsoft::Build::Framework::ICancelableTask, Microsoft::Build::Framework::IIncrementalTask, Microsoft::Build::Framework::IMultiThreadableTask

[Microsoft.Build.Framework.MSBuildMultiThreadableTask]
public sealed class Untar : Microsoft.Build.Tasks.TaskExtension, Microsoft.Build.Framework.ICancelableTask, Microsoft.Build.Framework.IIncrementalTask, Microsoft.Build.Framework.IMultiThreadableTask

[<Microsoft.Build.Framework.MSBuildMultiThreadableTask>]
type Untar = class
    inherit TaskExtension
    interface ICancelableTask
    interface ITask
    interface IIncrementalTask
    interface IMultiThreadableTask

Public NotInheritable Class Untar
Inherits TaskExtension
Implements ICancelableTask, IIncrementalTask, IMultiThreadableTask

Inheritance

Object

Task

TaskExtension

Untar

Attributes

MSBuildMultiThreadableTaskAttribute

Implements

ICancelableTask IIncrementalTask IMultiThreadableTask ITask

Remarks

This task uses the System.Formats.Tar APIs which are only available when MSBuild runs on .NET (not .NET Framework). It is therefore registered to run only on the .NET runtime and is unavailable in Visual Studio / MSBuild.exe.

Constructors

Name	Description
Untar()

Properties

Name	Description
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)
DestinationFolder	Gets or sets a ITaskItem with a destination folder path to untar the files to.
Exclude	Gets or sets an MSBuild glob expression that specifies which files to exclude from being untarred from the archive.
FailIfNotIncremental	Question the incremental nature of this task.
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)
Include	Gets or sets an MSBuild glob expression that specifies which files to include being untarred from the archive.
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)
OverwriteReadOnlyFiles	Gets or sets a value that indicates whether read-only files should be overwritten.
SkipUnchangedFiles	Gets or sets a value that indicates whether files should be skipped if the destination is unchanged.
SourceFiles	Gets or sets an array of ITaskItem objects containing the paths to tar archive files to untar. The compression (none, GZip, or ZStandard) is detected automatically from the archive contents.
TaskEnvironment	Gets or sets the task execution environment, which provides access to project current directory and environment variables in a thread-safe manner.
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

Name	Description
Cancel()	Instructs the task to exit as soon as possible, or to immediately exit if Execute is invoked after this method.
Execute()	Must be implemented by derived class.