The following tables list the members exposed by ArchiverBase.

      Public Constructors

      NameDescription
      Public ConstructorsArchiverBase ConstructorOverloaded. Initializes new instance of the ArchiverBase class.
      Top

      Public Properties

      NameDescription
      Public PropertiesStatic MemberBytesPerSecondUpdateIntervalGets or sets the number of milliseconds to update the BytesPerSecond property. The default value is 400 ms. (Inherited from FileSystem)
      Public PropertiesDirectorySeparatorsOverridden. Gets an array containing the characters that are directory separators.
      Public PropertiesFileInfoPartsToGetBeforeTransferringSpecifies which information of the source file will be obtained before transferring. (Inherited from FileSystem)
      Public PropertiesFileNameGets the archive file name.
      Public PropertiesFlushBuffersGets or sets the boolean value indicating whether to flush file buffers after any file modification and after extracting file from archive.
      Public PropertiesInUpdateGets a boolean value indicating if an archive file is being updated.
      Public PropertiesInvalidFileNameCharsGets or sets an array containing the characters that are not allowed in file or directory names, or null if this file system accepts all characters in file name. (Inherited from FileSystem)
      Public PropertiesInvalidFileNameCharsSubstitutionGets or sets the substitution character that will replace the invalid characters found in file or directory name while copying files from another file system. (Inherited from FileSystem)
      Public PropertiesInvalidPathCharsOverridden. Gets an array containing the characters that are not allowed in path names.
      Public PropertiesInvokeFromCurrentThreadsGets a value indicating whether to raise events from the current thread or to use a SynchronizationContext object available when an asynchronous operation was started. The default value is false. (Inherited from FileSystem)
      Public PropertiesOemCodePageGets the number of the OEM code page used to store and restore archive.
      Virtual Public PropertiesOpenedGets a boolean value indicating whether an archive file is opened.
      Public PropertiesPathStoringModeGets or sets the path storing mode. It defines how path information will be stored for files and directories within the archive .
      Public PropertiesProgressIntervalGets or sets the length of the interval in milliseconds between the Progress events fired during transfer. The default value is 100 ms. (Inherited from FileSystem)
      Public PropertiesRestoreFilePropertiesGets or sets a boolean value indicating whether to restore file properties including LastWriteTime and CreationTime after downloading or uploading if possible. (Inherited from FileSystem)
      Public PropertiesServerTimeZoneOffsetThis value is used to synchronize the CreationTime and LastWriteTime of files after a transfer. The default value is TimeSpan.Zero. (Inherited from FileSystem)
      Public PropertiesShareModeGets or sets the FileShare indicating the files being added to the archive will be opened for simultaneous access. The default value is FileShare.ReadWrite.
      Public PropertiesSizeGets the size in bytes of the opened archive file.
      Public PropertiesThreadIdGets the thread id. (Inherited from FileSystem)
      Public PropertiesTraceListenerManagerGets or sets the TraceListenerManager object to which the log messages generated by this object are sent. If not set, the Default trace listener manager is used. If this property is set to null, all messages from this object wont be logged. (Inherited from FileSystem)
      Public PropertiesTraceSourceGets or sets the source object for all log messages generated by this object. If not set, the property returns the current object. (Inherited from FileSystem)
      Public PropertiesUniqueIdGets the unique object id. (Inherited from FileSystem)
      Top

      Protected Properties

      NameDescription
      Protected PropertiesCanGetStreamForReadingOverridden. Returns a field indicating whether the system support getting stream for reading data from file. For internal uses only.
      Protected PropertiesCanGetStreamForWritingOverridden. Returns a field indicating whether the system support getting stream for writting data to file. For internal uses only.
      Top

      Public Methods

      NameDescription
      Public MethodsAddDirectoryOverloaded. Adds an entire directory or a file from the disk file system to the current working directory within the archive.
      Public MethodsAddFileOverloaded. Adds data stored in the specified buffer to the archive file.
      Public MethodsAddFileAsyncOverloaded. Asynchronously adds a file to the archive. File path within the archive will be determined by the PathStoringMode property.
      Virtual Public MethodsAddFileFromStringAdds string to the archive.
      Public MethodsAddFilesOverloaded. Adds files from the specified source directory on the specified source file system to the specified directory within the archive.
      Public MethodsAddFilesAsyncOverloaded. Asynchronous adds files from the specified source directory on the specified source file system to the specified directory within the archive.
      Public MethodsBeginUpdateBegins a transaction.
      Public MethodsStatic MemberCalculateTimeDiffCalculates the time difference between the source and the dest file systems. (Inherited from FileSystem)
      Public MethodsCancelOverloaded. Overridden. Cancels the current operation.
      Virtual Public MethodsCancelUpdateCancels all transactions. Rollback current transaction started by the BeginUpdate method. CancelUpdate clears all archive modifications made after calling BeginUpdate. CancelUpdate sets InUpdate property to false.
      Virtual Public MethodsCloseCloses the archive.
      Public MethodsCloseAsyncOverloaded. Asynchronously closes the archive.
      Public MethodsCombinePathOverloaded. Combines path strings. (Inherited from FileSystem)
      Public MethodsCopyFromOverloaded. Copies data in a stream to the specified destination file on this system. (Inherited from FileSystem)
      Public MethodsCopyFromAsyncOverloaded. Asynchronously copies data in a stream to the specified destination file on this system. (Inherited from FileSystem)
      Public MethodsStatic MemberCopyToOverloaded. Copies a file from this file system to another file system. (Inherited from FileSystem)
      Public MethodsStatic MemberCopyToAsyncOverloaded. Asynchronously copies a file from this file system to another file system. (Inherited from FileSystem)
      Virtual Public MethodsCreateCreates a new archive file with the specified name. If the archive file already exists, it will be overwritten.
      Public MethodsCreateDirectoryOverridden. Creates a new directory in the archive.
      Public MethodsCreateDirectoryAsyncOverloaded. Begins an asynchronous CreateDirectory operation. Creates an empty directory. (Inherited from FileSystem)
      Public MethodsCreateFileInfoOverloaded. Overridden. Creates a new instance of the ArchiveItem class and set appropriate file information.
      Public MethodsDeleteOverloaded. Deletes files and directories matching the specified search condition in the specified directory. This method only deletes the items in the specified directory if the baseDirectoryPath parameter does not end with a directory separator (e.g. '/' or '\'). To remove the whole directory, you should add a directory separator character at the end of that parameter. (Inherited from FileSystem)
      Public MethodsDeleteAllOverloaded. Deletes all files and directories within the archive.
      Public MethodsDeleteAsyncOverloaded. Asynchronously deletes files or directories and, if indicated, any subdirectories matching the specified search condition on the filesToDelete list. This method only deletes the items in the specified directory if the baseDirectoryPath parameter does not end with a directory separator (e.g. '/' or '\'). To remove the whole directory, you should add a directory separator character at the end of that parameter. (Inherited from FileSystem)
      Public MethodsDeleteDirectoryOverloaded. Overridden. Deletes an empty directory.
      Public MethodsDeleteDirectoryAsyncOverloaded. Asynchronously deletes the specified directory and, if indicated, any subdirectories and files in the directory. (Inherited from FileSystem)
      Public MethodsDeleteFileOverloaded. Overridden. Deletes a single file.
      Public MethodsDeleteFileAsyncOverloaded. Asynchronously deletes the specified file. (Inherited from FileSystem)
      Public MethodsDirectoryExistsOverridden. Determines whether the given path refers to an existing directory.
      Public MethodsDirectoryExistsAsyncOverloaded. Asynchronously detects whether the specified directory exists on the file system. (Inherited from FileSystem)
      Public MethodsDisposeReleases all used resources. (Inherited from FileSystem)
      Public MethodsEndUpdateEnds the current transaction initiated by a call to the BeginUpdate method.
      Public MethodsEnsuresDirectoryCreatedEnsures the specified directory exists on the file system. If the specified directory does not exist, a new one is to be created. (Inherited from FileSystem)
      Public MethodsExtractAllOverloaded. Extracts all files and directories within the archive.
      Public MethodsExtractAllAsyncOverloaded. Asynchronously extracts all files and directories within the archive.
      Public MethodsExtractFileOverloaded. Extracts the specified file to the specified destination file on the local disk.
      Virtual Public MethodsExtractFileAsyncOverloaded. Asynchronously extracts a file stored withing the archive to a Stream object descendant.
      Public MethodsExtractFileToStringExtracts a file stored withing the archive into a string.
      Public MethodsExtractFilesOverloaded. Extracts files from the specified directory within the archive to the destination directory on the destination file system.
      Public MethodsExtractFilesAsyncOverloaded. Asynchronously extracts files from the specified directory within the archive that match the search condition specified in the option parameter to the destination directory on the destination file system.
      Public MethodsFileExistsOverloaded. Overridden. Determines whether the given file path refers to an existing file.
      Public MethodsFileExistsAsyncOverloaded. Asynchronous detects whether the specified file exists on the file system. (Inherited from FileSystem)
      Public MethodsStatic MemberGetCommonChecksumAlgorithmsGets checksum algorithms that both file system have in common. (Inherited from FileSystem)
      Public MethodsGetCurrentDirectoryOverridden. Gets the current working directory in the archive.
      Public MethodsGetCurrentDirectoryAsyncOverloaded. Asynchronously gets the current working directory of the file system. (Inherited from FileSystem)
      Public MethodsGetDirectoryNameReturns the directory information for the specified path string. (Inherited from FileSystem)
      Public MethodsGetDirectorySizeOverloaded. Returns total size of the specified directories. (Inherited from FileSystem)
      Public MethodsGetDirectorySizeAsyncOverloaded. Asynchronously calculates total size of the specified directory. (Inherited from FileSystem)
      Public MethodsGetFileChecksumOverloaded. Returns the checksum of the specified file. (Inherited from FileSystem)
      Public MethodsGetFileChecksumAsyncOverloaded. Begins an asynchronous GetFileChecksum operation. Retrieves the size of the specified file. (Inherited from FileSystem)
      Virtual Public MethodsGetFileCountReturns the number of files in the archive file.
      Public MethodsGetFileLengthOverridden. Gets the file length in bytes.
      Public MethodsGetFileLengthAsyncOverloaded. Asynchronously retrieves the size of the specified file. (Inherited from FileSystem)
      Public MethodsGetFileNameReturns the file name and extension of the specified path string. (Inherited from FileSystem)
      Public MethodsGetFullPathReturns a full path of the specified path. (Inherited from FileSystem)
      Public MethodsGetItemInfoOverridden. Gets the file information.
      Public MethodsGetItemInfoAsyncOverloaded. Asynchronously retrieves a FileInfoBase containing the information about the specified file or directory. (Inherited from FileSystem)
      Public MethodsGetLastWriteTimeOverridden. Gets the date and time when archive item was last written to (last modified time).
      Public MethodsGetLastWriteTimeAsyncOverloaded. Asynchronous retrieves the modification date and time of the specified file. (Inherited from FileSystem)
      Public MethodsGetSupportedChecksumTypesOverridden. Returns the supported checksum types.
      Public MethodsIsCancelingOverloaded. Returns a boolean value indicating whether user has called the Cancel method. (Inherited from FileSystem)
      Public MethodsIsPathRootedGets a value indicating whether the specified path string contains absolute or relative path information. (Inherited from FileSystem)
      Public MethodsListAllOverloaded. Lists all files and subdirectories within the archive.
      Public MethodsListDirectoryOverloaded. Lists all files and subdirectories in the current working directory. This method returns the list of files and subdirectories in the first level of the current directory only. (Inherited from FileSystem)
      Public MethodsListDirectoryAsyncOverloaded. Asynchronously retrieves the list of files and directories in the specified directory. (Inherited from FileSystem)
      Public MethodsListNameOverloaded. Returns a list of file and directory names in the current directory. (Inherited from FileSystem)
      Public MethodsListNameAsyncOverloaded. Begins an asynchronous ListName operation. Retrieves the list of file and directory names in the current directory. (Inherited from FileSystem)
      Public MethodsMoveOverloaded. Moves files on the itemsToMove list that match the search condition specified in the options parameter to the destination directory using multiple threads. This method only moves the items of the specified directory if the sourcePath parameter does not end with a directory separator (e.g. '/' or '\'). To move the whole directory, use the Rename method instead. (Inherited from FileSystem)
      Public MethodsMoveAsyncOverloaded. Asynchronously moves files that match the search condition specified in the options parameter from the specified directory to the destination directory on this file system. This method only moves the items of the specified directory if the sourcePath parameter does not end with a directory separator (e.g. '/' or '\'). To move the whole directory, use the Rename method instead. (Inherited from FileSystem)
      Public MethodsNormalizePathOverloaded. Normalizes a path. This method normalizes path like "\my folder\\my sub folder/sub folder/\my file" to "/my folder/my sub folder/sub folder/my file" if directory separator character is '/'. (Inherited from FileSystem)
      Virtual Public MethodsOpenOverloaded. Opens or creates an archive file within a stream.
      Public MethodsQuickSynchronizeOverloaded. Synchronizes the specified directory on the specified destination file system with the specified source directory with the specified options. (Inherited from FileSystem)
      Public MethodsQuickSynchronizeAsyncOverloaded. Initiates an asynchronous operation to synchronize contents of a source directory and a local directory. (Inherited from FileSystem)
      Public MethodsRenameOverridden. Renames an existing file within the archive.
      Public MethodsRenameAsyncOverloaded. Begins an asynchronous Rename operation. Renames a file or directory on the file system. (Inherited from FileSystem)
      Public MethodsSearchOverloaded. Searches for files and directories that match the specified search conditions. (Inherited from FileSystem)
      Public MethodsSearchAsyncOverloaded. Searches for files and directories that match the specified search conditions. (Inherited from FileSystem)
      Public MethodsSetAttributesOverloaded. Updates attributes of the specified file. An exception is thrown if the specified file does not exist.
      Public MethodsSetCurrentDirectoryOverridden. Sets the current working directory in the archive.
      Public MethodsSetCurrentDirectoryAsyncOverloaded. Begins an asynchronous SetCurrentDirectory operation. (Inherited from FileSystem)
      Public MethodsSetLastWriteTimeOverridden. Sets the date and time that the specified file was last written to.
      Public MethodsSetLastWriteTimeAsyncOverloaded. Begins an asynchronous SetLastWriteTime operation. Sets the modification date and time of the specified file. (Inherited from FileSystem)
      Public MethodsSetMultipleFilesAttributesOverloaded. Updates attributes of multiple files.
      Public MethodsTestAllFilesOverloaded. Tests all files within the archive.
      Public MethodsTestFileOverloaded. Tests the specified file. It throws an exception if errors found.
      Public MethodsStatic MemberTransferFilesOverloaded. Transfers files from the specified source file system to the specified destination file system. (Inherited from FileSystem)
      Public MethodsStatic MemberTransferFilesAsyncOverloaded. Asynchronously transfers files from the specified source file system to the specified destination file system. (Inherited from FileSystem)
      Top

      Protected Methods

      NameDescription
      Protected MethodsDisposeOverridden. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
      Virtual Protected MethodsEndUpdateEnds the current transaction.
      Protected MethodsFinalizeReleases all used unmanaged resources. (Inherited from FileSystem)
      Protected MethodsGetItemInfoPartsBeforeTransferringIndicates whether the file system should obtains information of the source files before transferring. (Inherited from FileSystem)
      Virtual Protected MethodsOnAddFileCompletedRaises the AddFileCompleted event.
      Virtual Protected MethodsOnAddFilesCompletedRaises the AddFilesCompleted event.
      Virtual Protected MethodsOnCloseCompletedRaises the CloseCompleted event.
      Protected MethodsOnCopyFromCompletedRaises the CopyFromCompleted event. (Inherited from FileSystem)
      Protected MethodsOnCopyToCompletedRaises the CopyToCompleted event. (Inherited from FileSystem)
      Protected MethodsOnCreateDirectoryCompletedRaises the CreateDirectoryCompleted event. (Inherited from FileSystem)
      Protected MethodsOnDeleteCompletedRaises the DeleteCompleted event. (Inherited from FileSystem)
      Protected MethodsOnDeleteDirectoryCompletedRaises the DeleteDirectoryCompleted event. (Inherited from FileSystem)
      Protected MethodsOnDeleteFileCompletedRaises the DeleteFileCompleted event. (Inherited from FileSystem)
      Protected MethodsOnDirectoryExistsCompletedRaises the DirectoryExistsCompleted event. (Inherited from FileSystem)
      Virtual Protected MethodsOnExtractAllCompletedRaises the ExtractAllCompleted event.
      Virtual Protected MethodsOnExtractFileCompletedRaises the ExtractFileCompleted event.
      Virtual Protected MethodsOnExtractFilesCompletedRaises the ExtractFilesCompleted event.
      Protected MethodsOnFileExistsCompletedRaises the FileExistsCompleted event. (Inherited from FileSystem)
      Protected MethodsOnGetCurrentDirectoryCompletedRaises the GetCurrentDirectoryCompleted event. (Inherited from FileSystem)
      Protected MethodsOnGetDirectorySizeCompletedRaises the GetDirectorySizeCompleted event. (Inherited from FileSystem)
      Protected MethodsOnGetFileChecksumCompletedRaises the GetFileChecksumCompleted event. (Inherited from FileSystem)
      Protected MethodsOnGetFileLengthCompletedRaises the GetFileLengthCompleted event. (Inherited from FileSystem)
      Protected MethodsOnGetItemInfoCompletedRaises the GetItemInfoCompleted event. (Inherited from FileSystem)
      Protected MethodsOnGetLastWriteTimeCompletedRaises the GetLastWriteTimeCompleted event. (Inherited from FileSystem)
      Protected MethodsOnListDirectoryCompletedRaises the ListDirectoryCompleted event. (Inherited from FileSystem)
      Protected MethodsOnListNameCompletedRaises the ListNameCompleted event. (Inherited from FileSystem)
      Protected MethodsOnMoveFilesCompletedRaises the MoveCompleted event. (Inherited from FileSystem)
      Protected MethodsOnProgressOverridden. Raises the Progress event.
      Protected MethodsOnQuickSynchronizeCompletedRaises the QuickSynchronizeCompleted event. (Inherited from FileSystem)
      Protected MethodsOnRenameCompletedRaises the RenameCompleted event. (Inherited from FileSystem)
      Protected MethodsOnSearchCompletedRaises the SearchCompleted event. (Inherited from FileSystem)
      Protected MethodsOnSetCurrentDirectoryCompletedRaises the SetCurrentDirectoryCompleted event. (Inherited from FileSystem)
      Protected MethodsOnSetLastWriteTimeCompletedRaises the SetLastWriteTimeCompleted event. (Inherited from FileSystem)
      Protected MethodsOnThreadStateChangedRaises the ThreadStateChanged event. (Inherited from FileSystem)
      Protected MethodsOnTransferConfirmRaises the TransferConfirm event. (Inherited from FileSystem)
      Top

      Public Events

      NameDescription
      Public EventsAddFileCompletedOccurs when an asynchronous AddFileAsync operation completes.
      Public EventsAddFilesCompletedOccurs when an asynchronous AddFilesAsync operation completes.
      Public EventsCloseCompletedOccurs when an asynchronous CloseAsync operation completes.
      Public EventsCopyFromCompletedOccurs when an asynchronous CopyFromAsync operation completes. (Inherited from FileSystem)
      Public EventsCopyToCompletedOccurs when an asynchronous CopyToAsync operation completes. (Inherited from FileSystem)
      Public EventsCreateDirectoryCompletedOccurs when an asynchronous CreateDirectoryAsync operation completes. (Inherited from FileSystem)
      Public EventsDeleteCompletedOccurs when an asynchronous DeleteAsync operation completes. (Inherited from FileSystem)
      Public EventsDeleteDirectoryCompletedOccurs when an asynchronous DeleteDirectoryAsync operation completes. (Inherited from FileSystem)
      Public EventsDeleteFileCompletedOccurs when an asynchronous DeleteFileAsync operation completes. (Inherited from FileSystem)
      Public EventsDirectoryExistsCompletedOccurs when an asynchronous DirectoryExistsAsync operation completes. (Inherited from FileSystem)
      Public EventsExtractAllCompletedOccurs when an asynchronous ExtractAllAsync operation completes.
      Public EventsExtractFileCompletedOccurs when an asynchronous ExtractFileAsync operation completes.
      Public EventsExtractFilesCompletedOccurs when an asynchronous ExtractFilesAsync operation completes.
      Public EventsFileExistsCompletedOccurs when an asynchronous FileExistsAsync operation completes. (Inherited from FileSystem)
      Public EventsGetCurrentDirectoryCompletedOccurs when an asynchronous GetCurrentDirectoryAsync operation completes. (Inherited from FileSystem)
      Public EventsGetDirectorySizeCompletedOccurs when an asynchronous GetDirectorySizeAsync operation completes. (Inherited from FileSystem)
      Public EventsGetFileChecksumCompletedOccurs when an asynchronous GetFileChecksumAsync operation completes. (Inherited from FileSystem)
      Public EventsGetFileLengthCompletedOccurs when an asynchronous GetFileLengthAsync operation completes. (Inherited from FileSystem)
      Public EventsGetItemInfoCompletedOccurs when an asynchronous GetItemInfoAsync operation completes. (Inherited from FileSystem)
      Public EventsGetLastWriteTimeCompletedOccurs when an asynchronous GetLastWriteTimeAsync operation completes. (Inherited from FileSystem)
      Public EventsListDirectoryCompletedOccurs when an asynchronous ListDirectoryAsync operation completes. (Inherited from FileSystem)
      Public EventsListNameCompletedOccurs when an asynchronous ListNameAsync operation completes. (Inherited from FileSystem)
      Public EventsMoveCompletedOccurs after a MoveAsync call has been completed. (Inherited from FileSystem)
      Public EventsProgressOccurs when a block of data is transferred, or a file operation is being or has been executed. (Inherited from FileSystem)
      Public EventsQuickSynchronizeCompletedOccurs when an asynchronous QuickSynchronizeAsync operation completes. (Inherited from FileSystem)
      Public EventsRenameCompletedOccurs when an asynchronous RenameAsync operation completes. (Inherited from FileSystem)
      Public EventsSaveProgressOccurs when the archive or archive item is being saved to the disk.
      Public EventsSearchCompletedOccurs when an asynchronous search operation completes. (Inherited from FileSystem)
      Public EventsSetCurrentDirectoryCompletedOccurs when an asynchronous SetCurrentDirectoryAsync operation completes. (Inherited from FileSystem)
      Public EventsSetLastWriteTimeCompletedOccurs when an asynchronous SetLastWriteTimeAsync operation completes. (Inherited from FileSystem)
      Public EventsThreadStateChangedOccurs when the state of the thread is changed while in a multi-thread file transfer. (Inherited from FileSystem)
      Public EventsTransferConfirmOccurs when the file system has detected an issue while transferring files such as existing file found, symlink detected or an error encountered. (Inherited from FileSystem)
      Top

      See Also