View source for PT-BR/fileOpen

__NOTOC__
{{BR/Funcao compartilhada}}

Abre um arquivo existente para leitura e gravação.

{{BR/Nota|Para prevenir perdas de memórias, garanta que cada execução bem sucedida de [[PT-BR/fileOpen|fileOpen]] tenha um [[PT-BR/fileClose|fileClose]] para fechar o arquivo aberto.}}
{{BR/Tip|As funções que manipulam arquivos não devem ser utilizadas para implementar arquivos de configuração. É recomendado usar as [[Shared_Scripting_Functions#XML_functions|funções XML]].}}
{{MessageBox|bordercolorhex=FFB2B2|bgcolorhex=FFE5E5|image=File:Dialog-warning.png|title=Aviso:|message=A partir da versão 1.5.4 [https://buildinfo.mtasa.com/?Author=&Branch=&Revision=10413 r10413], esta função vai falhar quando tentar acessar um arquivo de script de outro resource, até mesmo com a permissão ''general.ModifyOtherObjects'' concedida, que usa uma conexão ''mysql'' através de [[dbConnect]] quando [[Server_mtaserver.conf#database_credentials_protection|''database_credentials_protection'']] estiver habilitado na configuração do servidor. Além disso, não será mais possível gravar no '''meta.xml''', ele será aberto apenas em modo leitura.}}
<!-- The {Warning} template didn't want to work with an external link to buildinfo, so I had to use the {MessageBox} template -->

==Sintaxe==
<syntaxhighlight lang="lua">
file fileOpen ( string filePath [, bool readOnly = false ])
</syntaxhighlight>

{{PT-BR/POO|A função vai apenas tentar abrir o arquivo, não vai criá-lo.|[[File]]}}

{{PT-BR/New feature/item|9.0156|1.5.6|11865|
{{PT-BR/POO|Esta é uma função estática abaixo da classe File. Usando '''File(...)''' vai abrir um arquivo caso existe, senão este será criado.|[[File]].open}}
}}

===Argumentos necessários===
*'''filePath:''' O [[filepath|caminho]] do arquivo a ser criado seguindo o seguinte formato: '''":resourceName/path"'''. '''resourceName''' é o nome do resource do arquivo que vai estar lá, e '''path''' é o caminho do arquivo relativo ao diretório do resource.
:Por exemplo, se existir um arquivo chamado ''coolObjects.txt'' no resource ''objectSearch'', esse arquivo pode ser aberto de um outro resource dessa forma: <code>fileOpen(":objectSearch/coolObjects.txt")</code>.
:Se o arquivo está no resource atual, apenas o caminho do arquivo é necessário, ex.: <<code>fileOpen("coolObjects.txt")</code>.

===Argumento opcional===
*'''readOnly:''' Por padrão, o arquivo é aberto com acesso de leitura e gravação. Você pode especificar '''true''' para esse argumento se você quiser o acesso apenas para leitura.

===Retorno===
Se aberto com sucesso, retorna o '''arquivo''' (objeto-arquivo) especificado. Caso contrário retorna '''false''' (ex.: se o arquivo não existir).

==Exemplo==
Este exemplo abre o arquivo "test.txt" que está na raiz do resource atual (onde o código tá sendo executado), e exibe o seu conteúdo no console.
<syntaxhighlight lang="lua">
local hFile = fileOpen("test.txt", true)       -- tentamos abrir o arquivo (em modo leitura)
if hFile then                                  -- verificamos se foi aberto com sucesso
    local buffer
    while not fileIsEOF(hFile) do              -- enquanto não estivermos o final do arquivo...
        buffer = fileRead(hFile, 500)          -- ... lemos os próximos 500 bytes ...
        outputConsole(buffer)                  -- ... e exibimos no console
    end
    fileClose(hFile)                           -- fechamos o arquivo depois de trabalhar com ele
else
    outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

This example show how to append data to an existing file:
Este exemplo mostra como inserir (sem substituir) um dado em um arquivo existente:
<syntaxhighlight lang="lua">
local hFile = fileOpen("test.txt")             -- tentamos abrir o arquivo (em modo leitura e gravação)
if hFile then                                  -- verificamos se foi aberto com sucesso
    fileSetPos( hFile, fileGetSize( hFile ) )  -- movemos a posição para o fim do arquivo
    fileWrite(hFile, "hello" )                 -- inserimos o valor que queremos
    fileFlush(hFile)                           -- Forçamos a gravação imediata do valor que inserimos no arquivo
    fileClose(hFile)                           -- fechamos o arquivo depois de trabalhar nele
else
    outputConsole("Unable to open test.txt")
end
</syntaxhighlight>

==Veja também==
{{PT-BR/File functions}}