CopyItemsTo(AbstractFolder,Boolean,Boolean,Object[]) Method

Copies the folder's items (files and empty folders) to another folder.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Sub CopyItemsTo( _

   ByVal destinationFolder As AbstractFolder, _

   ByVal recursive As Boolean, _

   ByVal replaceExistingFiles As Boolean, _

   ByVal ParamArray filters() As Object _

)

'Usage
 
Dim instance As AbstractFolder

Dim destinationFolder As AbstractFolder

Dim recursive As Boolean

Dim replaceExistingFiles As Boolean

Dim filters() As Object

 

instance.CopyItemsTo(destinationFolder, recursive, replaceExistingFiles, filters)

public void CopyItemsTo( 

   AbstractFolder destinationFolder,

   bool recursive,

   bool replaceExistingFiles,

   params object[] filters

)

Parameters

destinationFolder: An AbstractFolder object into which the folder's content must be copied. Cannot be null.
recursive: true if the content of the folders contained in the subfolders should be copied; false if only the current folder's content should be copied.
replaceExistingFiles: true if existing files in the destination should be replaced; false otherwise.
filters: An array of objects that can be used to filter the items to be copied.

Remarks

If the physical folder specified by destinationFolder does not exist, it is created.

The difference between CopyItemsTo() and CopyFilesTo() is how empty sub-folders are handled. CopyItemsTo() includes empty sub-folders in the copy operation while CopyFilesTo() only includes files and files found in sub-folders in the copy operation. Unless you specifically want to copy empty folders, it is best to use CopyFilesTo().

The folder's content (files, empty folders and subfolders) that matches the provided filters is
immediately copied to the destination.

When replacingExistingFiles is true, any file in the destination that has the same name as a file being copied is automatically replaced.

When replacingExistingFiles is false, an exception is thrown whenever the destination contains a file with the same name as a file being copied.

To filter a list of files or folders, you can pass a variable number of objects in the filters parameter. These objects may be of the following types:

Object type	Type of filter applied
System.String	The string is assumed to be a file mask, and a NameFilter object is automatically created for the passed string, with FilterScope.File as the default FilterScope.
System.IO.FileAttributes	An AttributeFilter object is automatically created for the provided attributes, with FilterScope.File as the default FilterScope.
Filter	The provided Filter object is used as-is.
Array of System.Object	Each object in the array may be of the types described in this table, and is used accordingly.
Other	If any other type is found, an exception is thrown.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

AbstractFolder Class
AbstractFolder Members
Overload List