TestCommand Class

Summary

Test one or more archives (Command: t).

The builder is TestCommandBuilder.

Namespace
Cake.SevenZip.Commands
Interfaces
Base Types
graph BT Type-->Base0["BaseOutputCommand<ITestOutput>"] Base0-->Base1["BaseCommand"] click Base1 "/Cake.7zip/api/Cake.SevenZip.Commands/BaseCommand" Base1-->Base2["object"] Type-.->Interface0["ICommand"] click Interface0 "/Cake.7zip/api/Cake.SevenZip.Commands/ICommand" Type-.->Interface1["ICanParseOutput"] Type-.->Interface2["IHaveArgumentArchive"] click Interface2 "/Cake.7zip/api/Cake.SevenZip.Arguments/IHaveArgumentArchive" Type-.->Interface3["IHaveArgumentFiles"] click Interface3 "/Cake.7zip/api/Cake.SevenZip.Arguments/IHaveArgumentFiles" Type-.->Interface4["IHaveArgument"] click Interface4 "/Cake.7zip/api/Cake.SevenZip.Arguments/IHaveArgument" Type-.->Interface5["ISupportSwitchIncludeArchiveFilenames"] click Interface5 "/Cake.7zip/api/Cake.SevenZip.Switches/ISupportSwitchIncludeArchiveFilenames" Type-.->Interface6["ISupportSwitchExcludeArchiveFilenames"] click Interface6 "/Cake.7zip/api/Cake.SevenZip.Switches/ISupportSwitchExcludeArchiveFilenames" Type-.->Interface7["ISupportSwitchDisableParsingOfArchiveName"] click Interface7 "/Cake.7zip/api/Cake.SevenZip.Switches/ISupportSwitchDisableParsingOfArchiveName" Type-.->Interface8["ISupportSwitchIncludeFilenames"] click Interface8 "/Cake.7zip/api/Cake.SevenZip.Switches/ISupportSwitchIncludeFilenames" Type-.->Interface9["ISupportSwitchExcludeFilenames"] click Interface9 "/Cake.7zip/api/Cake.SevenZip.Switches/ISupportSwitchExcludeFilenames" Type-.->Interface10["ISupportSwitchPassword"] click Interface10 "/Cake.7zip/api/Cake.SevenZip.Switches/ISupportSwitchPassword" Type-.->Interface11["ISupportSwitchNtfsAlternateStreams"] click Interface11 "/Cake.7zip/api/Cake.SevenZip.Switches/ISupportSwitchNtfsAlternateStreams" Type-.->Interface12["ISupportSwitchRecurseSubdirectories"] click Interface12 "/Cake.7zip/api/Cake.SevenZip.Switches/ISupportSwitchRecurseSubdirectories" Type-.->Interface13["ISupportSwitch"] click Interface13 "/Cake.7zip/api/Cake.SevenZip.Switches/ISupportSwitch" Type["TestCommand"] class Type type-node

Syntax

public sealed class TestCommand : BaseOutputCommand<ITestOutput>, ICommand, ICanParseOutput, 
    IHaveArgumentArchive, IHaveArgumentFiles, IHaveArgument, ISupportSwitchIncludeArchiveFilenames, 
    ISupportSwitchExcludeArchiveFilenames, ISupportSwitchDisableParsingOfArchiveName, 
    ISupportSwitchIncludeFilenames, ISupportSwitchExcludeFilenames, ISupportSwitchPassword, 
    ISupportSwitchNtfsAlternateStreams, ISupportSwitchRecurseSubdirectories, ISupportSwitch

Constructors

Name Summary
TestCommand() Initializes a new instance of the TestCommand class.

Properties

Name Value Summary
Archive FilePath?
Sets the archive the command operates on.
CommandChar string
Gets the command character. (e.g. "a", "u" or "e"...)
DisableParsingOfArchiveName SwitchDisableParsingOfArchiveName?
Gets or sets the SwitchDisableParsingOfArchiveName.
ExcludeArchiveFilenames SwitchExcludeArchiveFilenameCollection?
Gets or sets the SwitchExcludeArchiveFilenameCollection.
ExcludeFilenames SwitchExcludeFilenameCollection?
Gets or sets the SwitchExcludeFilenameCollection.
Files FilePathCollection?
Gets or sets the list of files this command operates on. These are single files. (I.e. to add to, or to remove from the archive).

For add and update, single files from the file-system will always be placed directly into the archive without any directory-structure.

Setting Files like this in add/update: 
Files = new[] {
  new FilePath("C:\\some\\place\\a.txt"),
  new FilePath("C:\\some\\other\\place\\b.txt"),
  new FilePath("C:\\a\\totally\\different\\place\\c.txt")
};
Will result in an archive: 
Archive.zip
- a.txt
- b.txt
- c.txt
without any directory structure.
IncludeArchiveFilenames SwitchIncludeArchiveFilenameCollection?
Gets or sets the SwitchIncludeArchiveFilenameCollection.
IncludeFilenames SwitchIncludeFilenameCollection?
Gets or sets the SwitchIncludeFilenameCollection.
NtfsAlternateStreams SwitchNtfsAlternateStreams?
Gets or sets the SwitchNtfsAlternateStreams.
Password SwitchPassword?
Gets or sets the SwitchPassword.
RecurseSubdirectories SwitchRecurseSubdirectories?
Gets or sets the SwitchRecurseSubdirectories.
Switches IEnumerable<ISwitch?>
Gets all supported switches.

Methods

Name Value Summary
BuildArgumentParams(ProcessArgumentBuilder) void
adds only the arguments to the builder. (i.e. Archive, files, directories).
BuildArguments(ProcessArgumentBuilder) void
Builds the arguments.
Inherited from BaseCommand
GitHub Discussion