TarDirectory Class

Definition

Namespace:: Microsoft.Build.Tasks

Assembly:: Microsoft.Build.Tasks.Core.dll

Package:: Microsoft.Build.Tasks.Core v18.11.0

Source:: TarDirectory.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.

Represents a task that can create a tar archive from a directory.

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

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

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

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

Inheritance: Object

Task

TaskExtension
TarDirectory

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
TarDirectory()

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)
Compression	Gets or sets the compression to apply to the tar archive. Supported values are `None` (the default), `GZip` and `ZStandard`, matched case-insensitively. This parameter is optional; when empty, no compression is applied.
DestinationFile	Gets or sets a ITaskItem with the path to the destination file to create.
DeterministicTimestamp	Gets or sets an optional timestamp to stamp on every entry in the archive in place of the source files' last-write times. Supplying this value makes the produced archive reproducible across machines and runs. The value may be an RFC 3339 date-time (for example, `2024-01-01T00:00:00Z`) or an integer number of seconds since the Unix epoch (for example, `1704067200`, which is also the form of `SOURCE_DATE_EPOCH`). When empty, each entry keeps its source file's last-write time (entries are always written in a deterministic order regardless of this value). This parameter is optional.
FailIfNotIncremental	Question the incremental nature of this task.
Format	Gets or sets the tar entry format to use for the archive. Supported values are `Pax` (the default), `Ustar`, `V7` and `Gnu`, matched case-insensitively. This parameter is optional; when empty, Pax is used.
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)
Overwrite	Gets or sets a value indicating whether the destination file should be overwritten.
SourceDirectory	Gets or sets a ITaskItem with the path to the source directory to create a tar archive from.
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()

Applies to