File.OpenHandle Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
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
Uma instância de SafeFileHandle.
Exceções
path é null.
path é uma cadeia de caracteres vazia (""), contém apenas espaço 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.
pathrefere-se a um dispositivo não arquivo, como CON:, , COM1:LPT1:etc. em um ambiente não NTFS.
preallocationSize é negativo.
-ou- mode, accessou share contém um valor inválido.
O arquivo não pode ser encontrado, como quando mode está Truncate ou Open, e o arquivo especificado por path não existe. O arquivo já deve existir nesses modos.
Ocorreu um erro de E/S, como especificar CreateNew quando o arquivo especificado por path ele já existe.
-ou- O disco estava cheio (quando preallocationSize foi fornecido e path estava apontando para um arquivo regular).
-ou- O arquivo era muito grande (quando preallocationSize foi fornecido e path estava apontando para um arquivo regular).
O chamador não tem a permissão necessária.
O caminho especificado é inválido, como estar em uma unidade não mapeada.
O access solicitado não é permitido pelo sistema operacional para o especificado path, como quando access é Write ou ReadWrite e o arquivo ou diretório está definido para acesso somente leitura.
-ou- Encrypted é especificado para options, mas a criptografia de arquivo não tem suporte na plataforma atual.
O caminho especificado, o nome do arquivo ou ambos excedem o comprimento máximo definido pelo sistema.