File.OpenHandle Metoda

Definice

Obor názvů:

System.IO

Sestavení:

netstandard.dll, System.Runtime.dll

Zdroj:

File.cs

Inicializuje novou instanci SafeFileHandle třídy se zadanou cestou, režimem vytvoření, oprávněním ke čtení/zápisu a sdílení, přístup k dalším souborům SafeFileHandles může mít stejný soubor, další možnosti souboru a velikost přidělení.

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

Relativní nebo absolutní cesta k souboru, který bude aktuální SafeFileHandle instance zapouzdřovat.

mode

FileMode

Jedna z hodnot výčtu, která určuje, jak otevřít nebo vytvořit soubor. Výchozí hodnota je Open

access

FileAccess

Bitová kombinace hodnot výčtu, která určuje způsob přístupu k souboru. Výchozí hodnota je Read

share

FileShare

Bitová kombinace hodnot výčtu, která určuje, jak bude soubor sdílen procesy. Výchozí hodnota je Read.

options

FileOptions

Objekt, který popisuje volitelné SafeFileHandle parametry, které se mají použít.

preallocationSize

Int64

Počáteční velikost přidělení souboru v bajtech. Kladná hodnota je platná pouze v případě, že se vytváří, přepisuje nebo nahrazuje běžný soubor. Záporné hodnoty nejsou povoleny. V jiných případech (včetně výchozí hodnoty 0) se ignoruje.

Návraty

SafeFileHandle

Instance SafeFileHandle

Výjimky

ArgumentNullException

path je null.

ArgumentException

path je prázdný řetězec (""), obsahuje pouze prázdné znaky nebo obsahuje jeden nebo více neplatných znaků. -nebo- path odkazuje na jiné než souborové zařízení, například CON:, COM1:, LPT1:atd. v prostředí NTFS.

NotSupportedException

pathodkazuje na zařízení, které není souborové, například CON:, COM1:LPT1:, atd. v prostředí jiného systému než NTFS.

ArgumentOutOfRangeException

preallocationSize je negativní. -or- mode, accessnebo share obsahují neplatnou hodnotu.

FileNotFoundException

Soubor nelze najít, například když mode je Truncate nebo Opena soubor zadaný path neexistuje. Soubor již musí v těchto režimech existovat.

IOException

Došlo k vstupně-výstupní CreateNew chybě, například určení, kdy soubor určený path již existuje. -nebo- Disk byl plný (když preallocationSize byl poskytnut a path odkazoval na běžný soubor). -nebo- Soubor byl příliš velký (při preallocationSize zadání a path odkazoval na běžný soubor).

SecurityException

Volající nemá požadované oprávnění.

DirectoryNotFoundException

Zadaná cesta je neplatná, například že je na nemapované jednotce.

UnauthorizedAccessException

Požadovaný access systém není pro zadaný pathoperační systém povolen, například kdy access je Write nebo ReadWrite je soubor nebo adresář nastaven pro přístup jen pro čtení. -nebo- Encrypted je zadán pro options, ale šifrování souborů není podporováno na aktuální platformě.

PathTooLongException

Zadaná cesta, název souboru nebo obojí překračují maximální délku definovanou systémem.