CopyAsync(IStorageFolder, String, NameCollisionOption) method
Collapse the table of content
Expand the table of content

IStorageFile.CopyAsync(IStorageFolder, String, NameCollisionOption) method

Creates a copy of the file in the specified folder, using the desired name. This method also specifies what to do if an existing file in the specified folder has the same name.

Syntax


Function CopyAsync(
  destinationFolder As IStorageFolder,  
  desiredNewName As String,  
  option As NameCollisionOption 
) As IAsyncOperation(Of StorageFile)

Parameters

destinationFolder

Type: IStorageFolder

The destination folder where the copy is created.

desiredNewName

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

The desired name of the copy.

If there is an existing file in the destination folder that already has the specified desiredNewName, the specified NameCollisionOption determines how Windows responds to the conflict.

option

Type: NameCollisionOption

An enum value that determines how Windows responds if the desiredNewName is the same as the name of an existing file in the destination folder.

Return value

Type: IAsyncOperation<StorageFile>

When this method completes, it returns a StorageFile that represents the copy.

Remarks

If you simply want to copy a file in your app, see the CopyAsync methods of the StorageFile class.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

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

IStorageFile
CopyAsync(IStorageFolder)
CopyAsync(IStorageFolder, String)
StorageFile.CopyAsync

 

 

Show:
© 2016 Microsoft