XarArchive.CreateEntries

CreateEntries(string, bool, XarCompressionSettings)

Adds to the archive all the files and directories recursively in the directory given.

public XarArchive CreateEntries(string sourceDirectory, bool includeRootDirectory = true, 
    XarCompressionSettings compressionSettings = null)
ParameterTypeDescription
sourceDirectoryStringDirectory to compress.
compressionSettingsBooleanThe compression settings used for added XarEntry items.
includeRootDirectoryXarCompressionSettingsIndicates whether to include the root directory itself or not.

Return Value

Xar entry instance.

Exceptions

exceptioncondition
ArgumentNullExceptionsourceDirectory is null.
SecurityExceptionThe caller does not have the required permission to access sourceDirectory.
ArgumentExceptionsourceDirectory contains invalid characters such as “, <, >, or |.
PathTooLongExceptionThe specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters. The specified path, file name, or both are too long.
IOExceptionsourceDirectory stands for a file, not for a directory.

Examples

using (FileStream xarFile = File.Open("archive.xar", FileMode.Create))
{
    using (var archive = new XarArchive())
    {
        archive.CreateEntries(@"C:\folder", false);
        archive.Save(xarFile);
    }
}

See Also


CreateEntries(DirectoryInfo, bool, XarCompressionSettings)

Adds to the archive all the files and directories recursively in the directory given.

public XarArchive CreateEntries(DirectoryInfo directory, bool includeRootDirectory = true, 
    XarCompressionSettings compressionSettings = null)
ParameterTypeDescription
directoryDirectoryInfoDirectory to compress.
compressionSettingsBooleanThe compression settings used for added XarEntry items.
includeRootDirectoryXarCompressionSettingsIndicates whether to include the root directory itself or not.

Return Value

Xar entry instance.

Exceptions

exceptioncondition
ArgumentNullExceptiondirectory is null.
SecurityExceptionThe caller does not have the required permission to access directory.
IOExceptiondirectory stands for a file, not for a directory.

Examples

using (FileStream xarFile = File.Open("archive.xar", FileMode.Create))
{
    using (var archive = new XarArchive())
    {
        archive.CreateEntries(new DirectoryInfo(@"C:\folder"), false);
        archive.Save(xarFile);
    }
}

See Also