Windows Dev Center

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

Creates a copy of the file in the specified folder and renames the copy.

Syntax


public IAsyncOperation<StorageFile> CopyAsync(
  IStorageFolder destinationFolder, 
  string desiredNewName
)

Parameters

destinationFolder

Type: IStorageFolder

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

desiredNewName

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The new name for the copy of the file created in the destinationFolder.

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(IStorageFolder, String, NameCollisionOption) method.

Examples

The following example copies a file to the specified folder and renames the copy by calling the CopyAsync(IStorageFolder, String) 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;

            // Specify a new name for the copied file.
            string renamedFileName = "renamed_test.txt";

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


Requirements (Windows 10 device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

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

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

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)
CopyAsync(IStorageFolder, String, NameCollisionOption)

 

 

Show:
© 2015 Microsoft