CreationCollisionOption Enum

Reference

Definition

Namespace:: Windows.Storage

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Specifies what to do if a file or folder with the specified name already exists in the current folder when you create a new file or folder.

public enum class CreationCollisionOption

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
enum class CreationCollisionOption

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public enum CreationCollisionOption

var value = Windows.Storage.CreationCollisionOption.generateUniqueName

Public Enum CreationCollisionOption

Inheritance: Enum
CreationCollisionOption

Attributes: ContractVersionAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Fields

Name	Value	Description
GenerateUniqueName	0	Automatically append a number to the base of the specified name if the file or folder already exists. For example, if `MyFile.txt` already exists, then the new file is named `MyFile (2).txt`. If `MyFolder` already exists, then the new folder is named `MyFolder (2)`.
ReplaceExisting	1	Replace the existing item if the file or folder already exists.
FailIfExists	2	Raise an exception of type System.Exception if the file or folder already exists. Methods that don't explicitly pass a value from the CreationCollisionOption enumeration use the FailIfExists value as the default when you try to create, rename, copy, or move a file or folder.
OpenIfExists	3	Return the existing item if the file or folder already exists.

Remarks

Methods that don't explicitly pass a value from the CreationCollisionOption enumeration use the FailIfExists value as the default when you create a file or folder.

For example, the CreateFileAsync method has one overload, CreateFileAsync (String, .CreationCollisionOption), that explicitly passes a value from the CreationCollisionOption enumeration. If you call the other overload, CreateFileAsync (String), the method uses the FailIfExists option as the default.

Applies to

Jaa