File.OpenHandle Metoda

Definicja

Przestrzeń nazw:

System.IO

Zestaw:

System.Runtime.dll

Źródło:

File.cs

Inicjuje nowe wystąpienie SafeFileHandle klasy z określoną ścieżką, trybem tworzenia, uprawnieniem do odczytu/zapisu i udostępniania, dostęp do innych plików SafeFileHandles może mieć taki sam plik, dodatkowe opcje pliku i rozmiar alokacji.

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

Parametry

path

String

Ścieżka względna lub bezwzględna dla pliku, który będzie hermetyzować bieżące SafeFileHandle wystąpienie.

mode

FileMode

Jedna z wartości wyliczenia, która określa sposób otwierania lub tworzenia pliku. Wartością domyślną jest Open.

access

FileAccess

Bitowa kombinacja wartości wyliczenia, która określa sposób uzyskiwania dostępu do pliku. Wartością domyślną jest Read.

share

FileShare

Bitowa kombinacja wartości wyliczenia, która określa sposób udostępniania pliku przez procesy. Wartość domyślna to Read.

options

FileOptions

Obiekt, który opisuje parametry opcjonalne SafeFileHandle do użycia.

preallocationSize

Int64

Początkowy rozmiar alokacji w bajtach dla pliku. Wartość dodatnia jest efektywna tylko wtedy, gdy jest tworzony, zastępowany lub zastępowany zwykły plik. Wartości ujemne są niedozwolone. W innych przypadkach (w tym wartość domyślna 0) jest ignorowana.

Zwraca

SafeFileHandle

SafeFileHandle Wystąpienie.

Wyjątki

ArgumentNullException

path to null.

ArgumentException

path jest pustym ciągiem (""), zawiera tylko białe znaki lub zawiera co najmniej jeden nieprawidłowy znak. -or— path odnosi się do urządzenia innego niż plik, takiego jak CON:, COM1:, LPT1:itp. w środowisku NTFS.

NotSupportedException

path odnosi się do urządzenia innego niż plik, takiego jak CON:, COM1:, LPT1:itp. w środowisku bez systemu plików NTFS.

ArgumentOutOfRangeException

preallocationSize jest ujemna. -or- mode, accesslub share zawierają nieprawidłową wartość.

FileNotFoundException

Nie można odnaleźć pliku, na przykład kiedy mode jest Truncate lub Open, a plik określony przez path program nie istnieje. Plik musi już istnieć w tych trybach.

IOException

Wystąpił błąd we/wy CreateNew , taki jak określenie, kiedy plik określony przez path już istnieje. -or - Dysk był zapełniony (kiedy preallocationSize został podany i path wskazywał zwykły plik). —lub — plik był za duży (gdy preallocationSize został podany i path wskazywał zwykły plik).

SecurityException

Obiekt wywołujący nie posiada wymaganych uprawnień.

DirectoryNotFoundException

Określona ścieżka jest nieprawidłowa, na przykład na dysku niezamapowanym.

UnauthorizedAccessException

Żądany access element nie jest dozwolony przez system operacyjny dla określonego pathelementu , na przykład w przypadku, gdy access plik Write lub ReadWrite katalog jest ustawiony na dostęp tylko do odczytu. -or- Encrypted jest określony dla options, ale szyfrowanie plików nie jest obsługiwane na bieżącej platformie.

PathTooLongException

Podana ścieżka, nazwa pliku lub obie przekraczają maksymalną długość zdefiniowaną przez system.