FileOpenDisposition Enum

Reference

Definition

Namespace:: Windows.Storage.Streams

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

Enumeration values for actions to take on a file.

public enum class FileOpenDisposition

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 327680)]
enum class FileOpenDisposition

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
public enum FileOpenDisposition

var value = Windows.Storage.Streams.FileOpenDisposition.openExisting

Public Enum FileOpenDisposition

Inheritance: Enum
FileOpenDisposition

Attributes: ContractVersionAttribute

Windows requirements

Device family	Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v5.0)

Fields

Name	Value	Description
OpenExisting	0	Opens a file only if it exists.
OpenAlways	1	Opens a file. If the file does not exist, a new file will be created and opened.
CreateNew	2	Creates a new file if one does not exist. If the file does exist, this will fail.
CreateAlways	3	Opens a file and truncates it so that its size is zero bytes. If the file does not exist, a new file will be created and opened.
TruncateExisting	4	Opens a file and truncates it so that its size is zero bytes. If the file does not exist, this will fail.

Remarks

The results of the FileOpenDisposition values depend on whether the file exists or not.

Applies to

Share via