StorageFile.CopyAsync(IStorageFolder) | copyAsync(IStorageFolder) method

Applies to Windows and Windows Phone

Creates a copy of the file in the specified folder.

Syntax


storageFile.copyAsync(destinationFolder).done( /* Your success and error handlers */ );

Parameters

destinationFolder

Type: IStorageFolder

The destination folder where the copy of the file is created.

Return value

Type: IAsyncOperation<StorageFile>

When this method completes, it returns a StorageFile that represents the copy of the file created in the destinationFolder.

Exceptions

ExceptionCondition
System.UnauthorizedAccessException

You don't have permission to copy a file into the destination folder.

Remarks

This method uses the FailIfExists value from the CreationCollisionOption enumeration by default. That is, this method raises an exception if a file with the same name already exists in the destination folder. If you want to handle a file name collision in a different way, call the CopyAsync(Windows.Storage.IStorageFolder,System.String,Windows.Storage.NameCollisionOption) method.

Examples

The following example copies a file to the specified folder by calling the CopyAsync() method.


using Windows.Storage;
using System.Threading.Tasks;
...
            // Get the app's temporary folder.
            StorageFolder tempFolder = ApplicationData.Current.TemporaryFolder;

            // Create a sample file in the temporary folder.
            string newFileName = "test.txt";
            StorageFile newFile = await tempFolder.CreateFileAsync(newFileName);

            // Get the app's local folder to use as the destination folder.
            StorageFolder localFolder = ApplicationData.Current.LocalFolder;

            // Copy the file to the destination folder.
            // Raise an exception if the file already exists.
            StorageFile copiedFile = await newFile.CopyAsync(localFolder);


Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8

Namespace

Windows.Storage
Windows::Storage [C++]

Metadata

Windows.winmd

See also

StorageFile
CopyAsync(IStorageFolder, String)
CopyAsync(IStorageFolder, String, NameCollisionOption)

 

 

Show:
© 2014 Microsoft