• Loading...
The following tables list the members exposed by RealTimeZip.

Public Constructors

NameDescription
Public ConstructorsRealTimeZip ConstructorOverloaded. Initializes a new instance of the RealTimeZip class.
Top

Public Properties

NameDescription
Public PropertiesBytesPerSecondUpdateIntervalGets or sets the number of milliseconds to update the BytesPerSecond property. The default value is 400 ms. (Inherited from FileSystem)
Public PropertiesCommentGets or sets the comment of the archive file.
Public PropertiesCompressedStreamSpecifies the compressed stream.
Public PropertiesCompressionLevelGets or sets the compression level used for adding files to the archive. Default value is Low.
Public PropertiesCompressionMethodGets or sets the compression algorithm used to compress archive items. Default value is CompressionMethod.Deflate.
Public PropertiesDirectorySeparatorsOverridden. Gets an array containing the characters that are directory separators.
Public PropertiesEncryptionAlgorithmGets or sets the archive encryption algorithm. Default value is EncryptionAlgorithm.None.
Public PropertiesFileInfoPartsToGetBeforeTransferringSpecifies which information of the source file will be obtained before transferring. (Inherited from FileSystem)
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)
Virtual Public PropertiesOpenedGets a boolean value indicating whether the archive is opened.
Public PropertiesPasswordGets or sets the password for files stored in the archive.
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 PropertiesStoreFileTimeGets or sets a boolean value indicating whether to save file modification, last access and creation times. Default value is true.
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)
Public PropertiesUseUnicodeFileNameExtraFieldGets or sets a boolean value indicating whether to use unicode extra field to store filename in unicode format. Default value is false.
Public PropertiesUseZip64Gets or sets a boolean value indicating whether to use Zip64 format to create archives over 4GB. Default value is false - Zip32 is used.
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 a file with path specified by localFilePath parameter to the archive. The archive item is to be saved with name specified in the archiveItemName parameter.
Public MethodsAddFileAsyncOverloaded. Asynchronously adds a file with path specified by localFilePath parameter to the archive. The archive item is to be saved with name specified in the archiveItemName parameter.
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 MethodsCalculateTimeDiffCalculates the time difference between the source and the dest file systems. (Inherited from FileSystem)
Public MethodsCancelOverloaded. Overridden. Cancels the current operation.
Public MethodsCloseCloses the archive.
Public MethodsCloseAsyncOverloaded. Asynchronously closes the archive.
Public MethodsCombinePathCombines two path strings. (Inherited from FileSystem)
Public MethodsCopyFromCopies data in a stream to the specified destination file on this system. (Inherited from FileSystem)
Public MethodsCopyFromAsyncAsynchronously copies data in a stream to the specified destination file on this system. (Inherited from FileSystem)
Public MethodsCopyToCopies a file from this file system to another file system. (Inherited from FileSystem)
Public MethodsCopyToAsyncAsynchronously copies a file from this file system to another file system. (Inherited from FileSystem)
Public MethodsCreateDirectoryOverridden. Creates an empty directory within the archive.
Public MethodsCreateDirectoryAsyncBegins 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 MethodsDeleteDeletes files or directories and, if indicated, any subdirectories matching the specified search condition on the filesToDelete list. (Inherited from FileSystem)
Public MethodsDeleteAsyncAsynchronously 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 MethodsDeleteDirectoryDeletes the specified directory and, if indicated, any subdirectories and files in the directory. (Inherited from FileSystem)
Public MethodsDeleteDirectoryAsyncAsynchronously deletes the specified directory and, if indicated, any subdirectories and files in the directory. (Inherited from FileSystem)
Public MethodsDeleteFileDeletes the specified file. (Inherited from FileSystem)
Public MethodsDeleteFileAsyncAsynchronously deletes the specified file. (Inherited from FileSystem)
Public MethodsDirectoryExistsOverridden. Determines whether the given path refers to an existing directory.
Public MethodsDirectoryExistsAsyncAsynchronously detects whether the specified directory exists on the file system. (Inherited from FileSystem)
Public MethodsDisposeReleases all used resources. (Inherited from FileSystem)
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 MethodsExtractFileOverloaded. Extracts the archive item found by the FindNextItemHeader method to the specified output file.
Public MethodsExtractFileAsyncOverloaded. Asynchronously extracts the archive item found by the FindNextItemHeader method to the specified output file.
Public MethodsFileExistsOverloaded. Overridden. Determines whether the given file path refers to an existing file.
Public MethodsFileExistsAsyncAsynchronous detects whether the specified file exists on the file system. (Inherited from FileSystem)
Public MethodsFindNextItemHeaderFinds next archive item header in the CompressedStream.
Public MethodsGetCommonChecksumAlgorithmsGets checksum algorithms that both file system have in common. (Inherited from FileSystem)
Public MethodsGetCurrentDirectoryGets the current working directory of the file system. (Inherited from FileSystem)
Public MethodsGetCurrentDirectoryAsyncAsynchronously 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 MethodsGetDirectorySizeReturns total size of the specified directories. (Inherited from FileSystem)
Public MethodsGetDirectorySizeAsyncAsynchronously calculates total size of the specified directory. (Inherited from FileSystem)
Public MethodsGetFileChecksumReturns the checksum of the specified file. (Inherited from FileSystem)
Public MethodsGetFileChecksumAsyncBegins an asynchronous GetFileChecksum operation. Retrieves the checksum of the specified file. (Inherited from FileSystem)
Public MethodsGetFileLengthOverridden. Gets the file length in bytes.
Public MethodsGetFileLengthAsyncAsynchronously 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 MethodsGetItemInfoAsyncAsynchronously 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 MethodsGetLastWriteTimeAsyncAsynchronous retrieves the modification date and time of the specified file. (Inherited from FileSystem)
Public MethodsGetSupportedChecksumTypesOverridden. Returns the supported checksum types.
Public MethodsIsCancelingReturns 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 MethodsListDirectoryLists 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 MethodsListDirectoryAsyncAsynchronously retrieves the list of files and directories in the specified directory. (Inherited from FileSystem)
Public MethodsListNameReturns a list of file and directory names in the current directory. (Inherited from FileSystem)
Public MethodsListNameAsyncBegins an asynchronous ListName operation. Retrieves the list of file and directory names in the current directory. (Inherited from FileSystem)
Public MethodsMoveMoves files that match the search condition specified in the options parameter from the specified directory 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 MethodsMoveAsyncAsynchronously 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 MethodsNormalizePathNormalizes 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)
Public MethodsOpenOverloaded. Opens or creates an archive within a stream.
Public MethodsQuickSynchronizeSynchronizes the specified local directory with the specified source directory with the specified options. (Inherited from FileSystem)
Public MethodsQuickSynchronizeAsyncInitiates an asynchronous operation to synchronize contents of a source directory and a local directory. (Inherited from FileSystem)
Public MethodsRenameMoves a specified file to a new location, providing the option to specify a new file name. (Inherited from FileSystem)
Public MethodsRenameAsyncBegins an asynchronous Rename operation. Renames a file or directory on the file system. (Inherited from FileSystem)
Public MethodsSearchSearches for files and directories that match the specified search pattern, if specified, in the directoryPath. (Inherited from FileSystem)
Public MethodsSearchAsyncSearches for files and directories that match the specified search conditions. (Inherited from FileSystem)
Public MethodsSetCurrentDirectorySets the file system's current working directory to the specified directory. (Inherited from FileSystem)
Public MethodsSetCurrentDirectoryAsyncBegins an asynchronous SetCurrentDirectory operation. (Inherited from FileSystem)
Public MethodsSetLastWriteTimeSets the date and time at which the specified file was last written. (Inherited from FileSystem)
Public MethodsSetLastWriteTimeAsyncBegins an asynchronous SetLastWriteTime operation. Sets the modification date and time of the specified file. (Inherited from FileSystem)
Public MethodsTransferFilesTransfers files from the specified source file system to the specified destination file system. (Inherited from FileSystem)
Public MethodsTransferFilesAsyncAsynchronously transfers files from the specified source file system to the specified destination file system. (Inherited from FileSystem)
Top

Protected Methods

NameDescription
Protected MethodsDisposeReleases all used resources. (Inherited from FileSystem)
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 MethodsOnErrorRaises the Error event.
Virtual Protected MethodsOnExtractFileCompletedRaises the ExtractFileCompleted 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)
Virtual Protected MethodsOnPasswordNeededRaises the PasswordNeeded event.
Protected MethodsOnProgressRaises the Progress event. (Inherited from FileSystem)
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 EventsErrorOccurs when an error has occurred.
Public EventsExtractFileCompletedOccurs when an asynchronous ExtractFileAsync 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 EventsPasswordNeededOccurs when a password for the encrypted file is needed.
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 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