Class FileIOFlags

Use these flags to document stream I/O method calls.

Inheritance
System.Object
FileIOFlags
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: WizardWrx
Assembly: WizardWrx.Common.dll
Syntax
public static class FileIOFlags

Fields

| Improve this Doc View Source

FILE_COPY_OVERWRITE_FORBIDDEN

File copy and stream I/O operations on existing files must fail.

This is the default behavior, and an existing file raises an IOException exception.

Declaration
public const bool FILE_COPY_OVERWRITE_FORBIDDEN = false
Field Value
Type Description
System.Boolean
See Also
| Improve this Doc View Source

FILE_COPY_OVERWRITE_PERMITTED

File copy and stream I/O operations on existing files overwrite.

Declaration
public const bool FILE_COPY_OVERWRITE_PERMITTED = true
Field Value
Type Description
System.Boolean
See Also
| Improve this Doc View Source

FILE_OUT_APPEND

Opening an output stream on a file that exists extends the file. The file is created if it doesn't exist.

The documentation implies, without explicitly saying so, that the default is overwrite.

Declaration
public const bool FILE_OUT_APPEND = true
Field Value
Type Description
System.Boolean
See Also
| Improve this Doc View Source

FILE_OUT_CREATE

Opening an output stream on a file that exists overwrites the file. Otherwise, a new file is created.

The documentation implies, without explicitly saying so, that the default is overwrite.

Declaration
public const bool FILE_OUT_CREATE = false
Field Value
Type Description
System.Boolean
See Also
| Improve this Doc View Source

FILE_READ_ENCODING_CHECK_FOR_BOM

When opening a text file for input, use the Byte Order Mark, if present, to establish its encoding.

The documentation in the MSDN library describes this parameter as follows.

"The detectEncodingFromByteOrderMarks parameter detects the encoding by looking at the first three bytes of the stream. It automatically recognizes UTF-8, little-endian Unicode, and big-endian Unicode text if the file starts with the appropriate byte order marks. Otherwise, the UTF8Encoding is used."

The documentation implies, without explicitly saying so, the text is assumed to be UTF-8 encoded unless you check for a Byte Order Mark, one is present, and it indicates otherwise.

Declaration
public const bool FILE_READ_ENCODING_CHECK_FOR_BOM = true
Field Value
Type Description
System.Boolean
See Also
| Improve this Doc View Source

FILE_READ_ENCODING_IGNORE_BOM

When opening a text file for input, ignore (expect none) the Byte Order Mark to establish its encoding.

The documentation in the MSDN library describes this parameter as follows.

"The detectEncodingFromByteOrderMarks parameter detects the encoding by looking at the first three bytes of the stream. It automatically recognizes UTF-8, little-endian Unicode, and big-endian Unicode text if the file starts with the appropriate byte order marks. Otherwise, the UTF8Encoding is used."

The documentation implies, without explicitly saying so, the text is assumed to be UTF-8 encoded unless you check for a Byte Order Mark, one is present, and it indicates otherwise.

Declaration
public const bool FILE_READ_ENCODING_IGNORE_BOM = false
Field Value
Type Description
System.Boolean
See Also
| Improve this Doc View Source

MAKE_STREAM_IO_ASYNCHRONOUS

Open stream for asynchronous I/O.

Declaration
public const bool MAKE_STREAM_IO_ASYNCHRONOUS = true
Field Value
Type Description
System.Boolean
See Also
| Improve this Doc View Source

MAKE_STREAM_IO_SYNCHRONOUS

Open stream for synchronous I/O. This is the default.

Declaration
public const bool MAKE_STREAM_IO_SYNCHRONOUS = false
Field Value
Type Description
System.Boolean
See Also