FileHandle
A classe FileHandle tem funções que lhe permitem ler sequencialmente ou anexar conteúdos a um objeto aberto File . O manuseamento de um arquivo pode acessar a qualquer parte de um documento.
Os objectos de manipulação de arquivos são criados com a função file.open() .
Para ler ou escrever um documento inteiro de uma só vez, pode considerar a utilização das funções file.getText() e file.setText() .
Graças ao objecto padrão 4D refcounting, um handle de arquivo é automaticamente apagado quando deixa de ser referenciado e, por conseguinte, o objeto solicitado arquivo é automaticamente fechado. Consequentemente, com os handles dos arquivos não precisa de se preocupar com o encerramento de documentos.
Exemplo
var $f : 4D.File
var $fhandle : 4D.FileHandle
$f:=Folder(Database folder).file("example.txt")
//Escrever linha por linha do início
$fhandle:=$f.open("write")
$text:="Hello World"
For ($line; 1; 4)
$fhandle.writeLine($text+String($line))
End for
//Escrever linha por linha do final
$fhandle:=$f.open("append")
$text:="Hello New World!"
For ($line; 1; 4)
$fhandle.writeLine($text+String($line))
End for
//Leitura usando um carácter de paragem e um parâmetro objecto
$o:=New object()
$o.mode:="read"
$o.charset:="UTF-8"
$o.breakModeRead:=Document with CRLF
$stopChar:="!"
$fhandle:=$f.open($o)
$text:=$fhandle.readText($stopChar)
//Leitura linha a linha
$lines:=New collection
$fhandle:=$f.open("read")
While (Not($fhandle.eof))
$lines.push($fhandle.readLine())
End while
Objeto FileHandle
Os objectos handle de arquivos não podem ser partilhados.
| .breakModeRead : Text o modo de processamento para quebras de linha utilizado na leitura do arquivo |
| .breakModeWrite : Text o modo de processamento para quebras de linha utilizado quando se escreve no arquivo |
| .charset : Text o charset utilizado na leitura ou na escrita do arquivo |
.eof : Boolean Verdadeiro se offset chegou ao fim do arquivo, e Falso caso contrário |
| .getSize() : Real devolve o tamanho atual do documento, expresso em bytes |
| .mode : Text o modo em que foi criado o tratamento do arquivo: "ler", "escrever", ou "anexar". |
| .offset : Real o offset aual do fluxo de dados (posição no interior do documento) |
| .readBlob( bytes : Real ) : [4D.Blob](BlobClass) devolve um blob a bytes tamanho do arquivo, a partir da posição atual |
| .readLine() : Text devolve uma linha de texto da posição atual até ser encontrado um delimitador de fim de linha ou até ser alcançado o fim do documento |
| .readText( { stopChar : Text } ) : Text devolve texto do arquivo, a partir da posição atual até à primeira stopChar string ser encontrada (se passada) ou o fim do arquivo ser alcançado |
| .setSize( size : Real ) estabelece um novo tamanho ** em bytes para o documento |
| .writeBlob( blob : 4D.Blob ) escreve blob no arquivo, a partir da posição atual |
| .writeLine( lineOfText : Text ) escreve lineOfText conteúdo na posição atual e insere um delimitador de fim de linha |
| .writeText( textToWrite : Text ) escreve textToWrite conteúdo na posição atual e não insere um delimitador final de fim de linha |
.breakModeRead
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.breakModeRead : Text
Descrição
A propriedade .breakModeRead devolve o modo de processamento para quebras de linha utilizado na leitura do arquivo.
A propriedade .breakModeRead pode ser definida na criação do cabo com a função file.open() (ver o .open() function para mais informações). O padrão é "nativo".
A propriedade
.breakModeReadcontém sempre um valor de texto, mesmo que a opção.open()tenha sido definida usando um número (constante).
Essa propriedade é apenas leitura.
.breakModeWrite
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.breakModeWrite : Text
Descrição
A propriedade .breakModeWrite devolve o modo de processamento para quebras de linha utilizado quando se escreve no arquivo.
A propriedade .breakModeWrite pode ser definida na criação do handle com a função file.open() (ver a função .open() função para mais informações). O padrão é "nativo".
A propriedade
.breakModeWritecontém sempre um valor de texto, mesmo que a opção.open()tenha sido definida utilizando um número (constante).
Essa propriedade é apenas leitura.
.charset
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.charset : Text
Descrição
O .charset devolve propriedades o charset utilizado na leitura ou na escrita do arquivo.
O charset pode ser definido na criação do cabo com a função file.open() . Por padrão é "UTF-8".
Essa propriedade é apenas leitura.
.eof
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.eof : Boolean
Descrição
A propriedade .eof devolve Verdadeiro se offset chegou ao fim do arquivo, e Falso caso contrário.
Essa propriedade é apenas leitura.
.getSize()
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.getSize() : Real
| Parâmetros | Tipo | Descrição | |
|---|---|---|---|
| Resultados | Real | <- | Tamanho do documento em bytes |
|
Descrição
A função .getSize() devolve o tamanho atual do documento, expresso em bytes.
Esta função devolve o mesmo valor que a propriedade (.size) da classe
File.
Veja também
.mode
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.mode : Text
Descrição
A propriedade .mode devolve o modo em que foi criado o tratamento do arquivo: "ler", "escrever", ou "anexar"..
O modo pode ser definido na criação do punho com a função file.open() . O padrão é "read".
Essa propriedade é apenas leitura.
.offset
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.offset : Real
Descrição
A propriedade .offset devolve o offset aual do fluxo de dados (posição no interior do documento). O valor do offset é automaticamente atualizado após as operações de leitura e escrita.
A configuração do .offset irá alterar o seu valor atual.
- Se o valor passado for negativo, o arquivo
.offseté definido para o início do arquivo (zero). - Se o valor passado for superior ao tamanho do arquivo, o arquivo
.offseté definido para o fim do arquivo (tamanho do ficheiro).
Esta propriedade é read/write.
.readBlob()
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.readBlob( bytes : Real ) : 4D.Blob
| Parâmetros | Tipo | Descrição | |
|---|---|---|---|
| bytes | Real | -> | Número de bytes a ler |
| Resultados | 4D.Blob | <- | Bytes lidos do arquivo |
|
Descrição
A função .readBlob() devolve um blob a bytes tamanho do arquivo, a partir da posição atual .
Quando esta função é executada, a posição atual (.offset) é atualizada após a leitura do último byte.
Veja também
.readLine()
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.readLine() : Text
| Parâmetros | Tipo | Descrição | |
|---|---|---|---|
| Resultados | Text | <- | Linha de texto |
|
Descrição
A função .readLine() devolve uma linha de texto da posição atual até ser encontrado um delimitador de fim de linha ou até ser alcançado o fim do documento.
Quando esta função é executada, a posição atual (.offset) é atualizada.
Quando esta função é executada pela primeira vez num handle de arquivo, todo o conteúdo do documento é carregado num buffer.
Veja também
.readText()
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.readText( { stopChar : Text } ) : Text
| Parâmetros | Tipo | Descrição | |
|---|---|---|---|
| stopChar | Text | -> | Caracter no qual parar a leitura |
| Resultados | Text | <- | Texto do arquivo |
|
Descrição
A função .readText() devolve texto do arquivo, a partir da posição atual até à primeira stopChar string ser encontrada (se passada) ou o fim do arquivo ser alcançado.
Esta função substitui todos os delimitadores de fim de linha originais. Como padrão, é utilizado o delimitador nativo, mas pode definir outro delimitador quando abrir o cabo do arquivo definindo a propriedade .breakModeRead .
A string de caracteres stopChar não está incluída no texto devolvido. Se omitir o parâmetro stopChar , todo o texto do documento é devolvido.
Quando esta função é executada, o (.offset) é colocado logo após a string stopChar.
Se o parâmetro stopChar for passado e não for encontrado, .readText() devolve uma string vazia e o .offset é deixado intocado.
Quando esta função é executada pela primeira vez num handle de arquivo, todo o conteúdo do documento é carregado num buffer.
Veja também
.setSize()
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.setSize( size : Real )
| Parâmetros | Tipo | Descrição | |
|---|---|---|---|
| size | Real | -> | Novo tamanho do documento em bytes |
|
Descrição
A função .setSize() estabelece um novo tamanho ** em bytes para o documento.
Se o tamanho for inferior ao tamanho atual do documento, o conteúdo do documento é truncado desde o início para obter o novo tamanho .
Veja também
.writeBlob()
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.writeBlob( blob : 4D.Blob )
| Parâmetros | Tipo | Descrição | |
|---|---|---|---|
| blob | 4D.Blob | -> | Blob para escrever no arquivo |
|
Descrição
A função .writeBlob() escreve blob no arquivo, a partir da posição atual .
Quando esta função for executada, a posição atual (.offset) é atualizada depois do último byte escrito.
Veja também
.writeLine()
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.writeLine( lineOfText : Text )
| Parâmetros | Tipo | Descrição | |
|---|---|---|---|
| lineOfText | Text | -> | Texto para string |
|
Descrição
A função .writeLine() escreve lineOfText conteúdo na posição atual e insere um delimitador de fim de linha (ao contrário da função .writeText()). Como padrão, é utilizado um delimitador nativo de fim de linha, mas pode definir outro delimitador quando abrir o handle do arquivo definindo a propriedade .breakModeWrite .
Quando esta função é executada, a posição atual (.offset) é atualizada após o delimitador de fim de linha.
Veja também
.breakModeWrite, .readLine(), .writeText()
.writeText()
Histórico
| Versão | Mudanças |
|---|---|
| v19 R7 | Adicionado |
.writeText( textToWrite : Text )
| Parâmetros | Tipo | Descrição | |
|---|---|---|---|
| textToWrite | Text | -> | Texto para string |
|
Descrição
A função .writeText() escreve textToWrite conteúdo na posição atual e não insere um delimitador final de fim de linha (ao contrário da função .writeLine()). Esta função substitui todos os delimitadores de fim de linha originais. Como padrão, é utilizado o delimitador nativo, mas pode definir outro delimitador quando abrir o handle do arquivo definindo a propriedade .breakModeWrite .
Quando esta função for executada, a posição atual (.offset) é atualizada após o próximo delimitador de fim de linha.