File.OpenHandle Метод

Определение

Пространство имен:

System.IO

Сборки:

netstandard.dll, System.Runtime.dll

Исходный код:

File.cs

Инициализирует новый экземпляр SafeFileHandle класса с указанным путем, режимом создания, разрешением на чтение и запись и общий доступ, доступ к другому файлу SafeFileHandles может иметь один и тот же файл, дополнительные параметры файла и размер выделения.

public static Microsoft.Win32.SafeHandles.SafeFileHandle OpenHandle(string path, System.IO.FileMode mode = System.IO.FileMode.Open, System.IO.FileAccess access = System.IO.FileAccess.Read, System.IO.FileShare share = System.IO.FileShare.Read, System.IO.FileOptions options = System.IO.FileOptions.None, long preallocationSize = 0);

static member OpenHandle : string * System.IO.FileMode * System.IO.FileAccess * System.IO.FileShare * System.IO.FileOptions * int64 -> Microsoft.Win32.SafeHandles.SafeFileHandle

Public Shared Function OpenHandle (path As String, Optional mode As FileMode = System.IO.FileMode.Open, Optional access As FileAccess = System.IO.FileAccess.Read, Optional share As FileShare = System.IO.FileShare.Read, Optional options As FileOptions = System.IO.FileOptions.None, Optional preallocationSize As Long = 0) As SafeFileHandle

Параметры

path

String

Относительный или абсолютный путь к файлу, который будет инкапсулировать текущий SafeFileHandle экземпляр.

mode

FileMode

Одно из значений перечисления, определяющее, как открыть или создать файл. Значение по умолчанию — Open.

access

FileAccess

Побитовое сочетание значений перечисления, определяющее способ доступа к файлу. Значение по умолчанию — Read.

share

FileShare

Побитовое сочетание значений перечисления, определяющее, как файл будет совместно использоваться процессами. Значение по умолчанию — Read.

options

FileOptions

Объект, описывающий необязательные параметры SafeFileHandle для использования.

preallocationSize

Int64

Начальный размер выделения в байтах для файла. Положительное значение действует только при создании, перезаписи или замене обычного файла. Отрицательные значения не допускаются. В других случаях (включая значение по умолчанию 0), он игнорируется.

Возвращаемое значение

SafeFileHandle

SafeFileHandle Экземпляр.

Исключения

ArgumentNullException

path равно null.

ArgumentException

path — пустая строка (""), содержит только пробелы или содержит один или несколько недопустимых символов. -or- path ссылается на нефайловое устройство, например CON:, COM1:и LPT1:т. д. в среде NTFS.

NotSupportedException

path ссылается на устройство, отличное от файлов, например CON:, COM1:и LPT1:т. д. в среде, отличной от NTFS.

ArgumentOutOfRangeException

preallocationSize отрицательно. -или- modeaccessили share содержит недопустимое значение.

FileNotFoundException

Не удается найти файл, например, когда mode он Truncate или Openфайл, указанный path не существует. Файл должен уже существовать в этих режимах.

IOException

Ошибка ввода-вывода, например указание CreateNew , когда файл, указанный path уже существует, произошел. -или- Диск был заполнен (когда preallocationSize он был указан и path указывал на обычный файл). -или- Файл был слишком большим (когда preallocationSize он был указан и path указывал на обычный файл).

SecurityException

Вызывающий объект не имеет требуемого разрешения.

DirectoryNotFoundException

Указанный путь недопустим, например на несопоставленном диске.

UnauthorizedAccessException

Запрошенная access операционная система не разрешена для указанной pathоперационной системы, например, если accessWrite файл или ReadWrite каталог задан для доступа только для чтения. -или- Encrypted указано для options, но шифрование файлов не поддерживается на текущей платформе.

PathTooLongException

Указанный путь, имя файла или оба превышают определенную системой максимальную длину.