File.OpenHandle Método

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Origem:

File.cs

Inicializa uma nova instância da SafeFileHandle classe com o caminho especificado, o modo de criação, a permissão de leitura/gravação e compartilhamento, o acesso que outros SafeFileHandles podem ter para o mesmo arquivo, opções de arquivo adicionais e o tamanho da alocação.

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

Parâmetros

path

String

Um caminho relativo ou absoluto para o arquivo que a instância atual SafeFileHandle encapsulará.

mode

FileMode

Um dos valores de enumeração que determina como abrir ou criar o arquivo. O valor padrão é Open

access

FileAccess

Uma combinação bit a bit dos valores de enumeração que determina como o arquivo pode ser acessado. O valor padrão é Read

share

FileShare

Uma combinação bit a bit dos valores de enumeração que determina como o arquivo será compartilhado por processos. O valor padrão é Read.

options

FileOptions

Um objeto que descreve parâmetros opcionais SafeFileHandle a serem usados.

preallocationSize

Int64

O tamanho da alocação inicial em bytes para o arquivo. Um valor positivo só é eficaz quando um arquivo regular está sendo criado, substituído ou substituído. Valores negativos não são permitidos. Em outros casos (incluindo o valor padrão 0), ele é ignorado.

Retornos

SafeFileHandle

Uma instância de SafeFileHandle.

Exceções

ArgumentNullException

path é null.

ArgumentException

path é uma cadeia de caracteres vazia (“”), contém somente espaços em branco ou contém um ou mais caracteres inválidos. -ou- path refere-se a um dispositivo não arquivo, como CON:, COM1:, LPT1:etc. em um ambiente NTFS.

NotSupportedException

path refere-se a um dispositivo não arquivo, como CON:, COM1:, LPT1:etc. em um ambiente não NTFS.

ArgumentOutOfRangeException

preallocationSize é negativo. -ou- mode, accessou share contêm um valor inválido.

FileNotFoundException

Não é possível localizar o arquivo, por exemplo, quando mode é Truncate ou Open e o arquivo especificado por path não existe. O arquivo já deve existir em um desses modos.

IOException

Ocorreu um erro de E/S, como especificar CreateNew quando o arquivo especificado por path já existe. -ou- O disco estava cheio (quando preallocationSize foi fornecido e path apontava para um arquivo regular). -ou- O arquivo era muito grande (quando preallocationSize foi fornecido e path apontava para um arquivo regular).

SecurityException

O chamador não tem a permissão necessária.

DirectoryNotFoundException

O caminho especificado é inválido, por exemplo, ele está em uma unidade não mapeada.

UnauthorizedAccessException

O access solicitado não é permitido pelo sistema operacional para o path especificado, como quando access é Write ou ReadWrite, e o arquivo ou diretório está configurado para acesso somente leitura. -ou- Encrypted é especificado para options, mas a criptografia de arquivo não tem suporte na plataforma atual.

PathTooLongException

O caminho especificado, o nome de arquivo, ou ambos excedem o tamanho máximo definido pelo sistema.