File
Os objetos File
são criados com o comando File
. Contêm referências a ficheiros de disco que podem ou não existir efectivamente no disco. Por exemplo, quando você executa o comando File
para criar um arquivo, um objeto File
válido é criado, mas nada é realmente armazenado no disco até que você chame a função file.create( )
.
Exemplo
O exemplo seguinte cria um arquivo de preferências na pasta do projecto:
var $created : Boolean
$created:=File("/PACKAGE/SpecialPrefs/"+Current user+".myPrefs").create()
Pathnames
Os objetos File
suportam vários pathnames, incluindo a sintaxe filesystems
ou posix
. Os nomes de caminho compatíveis são detalhados na página Rotas de acesso.
Objeto File
.copyTo( destinationFolder : 4D.Folder { ; newName : Text } { ; overwrite : Integer } ) : 4D.File copies the File object into the specified destinationFolder |
.create() : Boolean cria um arquivo no disco de acordo com as propriedades do objeto File |
.createAlias( destinationFolder : 4D.Folder ; aliasName : Text { ; aliasType : Integer } ) : 4D.File cria um alias (macOS) ou um atalho (Windows) |
.creationDate : Date the creation date of the file |
.creationTime : Time the creation time of the file |
.delete() exclui o arquivo |
.exists : Boolean true if the file exists on disk |
.extension : Text the extension of the file name (if any) |
.fullName : Text the full name of the file, including its extension (if any) |
.getAppInfo() : Object retorna o conteúdo de um arquivo .exe, .dll ou .plist como um objeto |
.getContent( ) : 4D.Blobreturns a 4D.Blob object containing the entire content of a file |
.getIcon( { size : Integer } ) : Picture the icon of the file |
.getText( { charSetName : Text { ; breakMode : Integer } } ) : Text .getText( { charSetNum : Integer { ; breakMode : Integer } } ) : Text returns the contents of the file as text |
.hidden : Boolean true if the file is set as "hidden" at the system level |
.isAlias : Boolean true if the file is an alias, a shortcut, or a symbolic link |
.isFile : Boolean always true for a file |
.isFolder : Boolean always false for a file |
.isWritable : Boolean true if the file exists on disk and is writable |
.modificationDate : Date the date of the file's last modification |
.modificationTime : Time the time of the file's last modification |
.moveTo( destinationFolder : 4D.Folder { ; newName : Text } ) : 4D.File move ou renomeia o objeto File para a destinationFolder especificada |
.name : Text the name of the file without extension (if any) |
.open( { mode : Text } ) : 4D.FileHandle .open( { options : Object } ) : 4D.FileHandle cria e retorna um novo objeto 4D.FileHandle no arquivo, no mode especificado ou com as options especificadas |
.original : 4D.File .original : 4D.Folder the target element for an alias, a shortcut, or a symbolic link file |
.parent : 4D.Folder the parent folder object of the file |
.path : Text the POSIX path of the file |
.platformPath : Text the path of the file expressed with the current platform syntax |
.rename( newName : Text ) : 4D.File renames the file with the name you passed in newName and returns the renamed File object |
.setAppInfo( info : Object ) escreve as propriedades info como o conteúdo da informação de um arquivo .exe, .dll ou .plist |
.setContent ( content : Blob ) rewrites the entire content of the file using the data stored in the content BLOB |
.setText ( text : Text {; charSetName : Text { ; breakMode : Integer } } ) .setText ( text : Text {; charSetNum : Integer { ; breakMode : Integer } } ) writes text as the new contents of the file |
.size : Real the size of the file expressed in bytes |
4D. File.new()
História
Release | Mudanças |
---|---|
18 R6 | Adicionado |
4D.File.new ( path : Text { ; pathType : Integer } ) : 4D.File
4D.File.new ( fileConstant : Integer ) : 4D.File
Descrição
A função 4D.File.new()
cria e retorna um novo objeto do tipo 4D.File
. É idêntico ao comando File
(atalho).
Recomenda-se usar o comando de atalho
File
em vez de4D.File.new()
.
.copyTo()
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.copyTo( destinationFolder : 4D.Folder { ; newName : Text } { ; overwrite : Integer } ) : 4D.File
Parâmetro | Tipo | Descrição | |
---|---|---|---|
destinationFolder | 4D. Folder | -> | Pasta de destino |
newName | Text | -> | Nome para a copia |
overwrite | Integer | -> | fk overwrite para substituir os elementos existentes |
Resultados | 4D. File | <- | Arquivo copiado |
Descrição
The .copyTo()
function copies the File
object into the specified destinationFolder .
The destinationFolder must exist on disk, otherwise an error is generated.
Como padrão, o arquivo é copiado com o nome do arquivo original. If you want to rename the copy, pass the new name in the newName parameter. O novo nome deve cumprir com as regras de nomenclatura (por exemplo, não deve conter caracteres como ":", "/", etc.), do contrário se devolve um erro.
If a file with the same name already exists in the destinationFolder, by default 4D generates an error. You can pass the fk overwrite
constant in the overwrite parameter to ignore and overwrite the existing file
Parâmetros | Valor | Comentário |
---|---|---|
fk overwrite | 4 | Sobrescrever os elementos existentes, se houver |
Valor retornado
O objeto File
copiado.
Exemplo
You want to copy a picture file from the user's document folder to the application folder:
var $source; $copy : Object
$source:=Folder(fk documents folder).file("Pictures/photo.png")
$copy:=$source.copyTo(Folder("/PACKAGE");fk overwrite)
.create()
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
Não disponível para arquivos ZIP
.create() : Boolean
Parâmetro | Tipo | Descrição | |
---|---|---|---|
Resultados | Parâmetros | <- | True se o arquivo foi criado com sucesso, false caso contrário |
Descrição
A função .create()
cria um arquivo no disco de acordo com as propriedades do objeto File
.
Se necessário, a função cria a hierarquia de pastas conforme descrito nas propriedades platformPath ou path. Se o arquivo já existir no disco, a função não faz nada (não é atirado nenhum erro) e retorna falso.
Valor retornado
- True se o arquivo for criado com sucesso;
- False se já existir um arquivo com o mesmo nome ou se tiver ocorrido um erro.
Exemplo
Criação de um arquivo de preferências na pasta da base de dados:
var $created : Boolean
$created:=File("/PACKAGE/SpecialPrefs/"+Current user+".myPrefs").create()
.createAlias()
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.createAlias( destinationFolder : 4D.Folder ; aliasName : Text { ; aliasType : Integer } ) : 4D.File
Parâmetro | Tipo | Descrição | |
---|---|---|---|
destinationFolder | 4D. Folder | -> | Pasta de destino para o pseudónimo ou atalho |
aliasName | Text | -> | Nome do pseudónimo ou atalho |
aliasType | Integer | -> | Tipo de ligação do pseudónimo |
Resultados | 4D. File | <- | Referência a pseudónimo ou ficheiro de atalho |
Descrição
A função .createAlias()
cria um alias (macOS) ou um atalho (Windows) para o arquivo com o nome aliasName especificado na pasta designada pelo objeto destinationFolder.
Passar o nome do alias ou atalho para criar no parâmetro aliasName.
Por padrão em macOS, a função cria um pseudónimo padrão. Também pode criar uma ligação simbólica utilizando o parâmetro aliasType. Estão disponíveis as seguintes constantes:
Parâmetros | Valor | Comentário |
---|---|---|
fk alias link | 0 | Alias link (padrão) |
fk symbolic link | 1 | Link simbólico (só em macOS) |
No Windows, é sempre criado um atalho (arquivo.lnk) (o parâmetro aliasType é ignorado).
Objeto devolvido
Um objeto 4D.File
com a propriedade isAlias
definida como true.
Exemplo
Se quiser criar um alias para um arquivo na sua pasta database:
$myFile:=Folder(fk documents folder).file("Archives/ReadMe.txt")
$aliasFile:=$myFile.createAlias(File("/PACKAGE");"ReadMe")
.creationDate
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.creationDate : Date
Descrição
The .creationDate
property returns the creation date of the file.
Essa propriedade é somente leitura.
.creationTime
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.creationTime : Time
Descrição
The .creationTime
property returns the creation time of the file (expressed as a number of seconds beginning at 00:00).
Essa propriedade é somente leitura.
.delete()
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.delete()
Parâmetro | Tipo | Descrição | |
---|---|---|---|
Não exige nenhum parâmetro |
Descrição
A função .delete()
exclui o arquivo.
Se o arquivo não existir no disco, a função não faz nada (não é gerado nenhum erro).
Se o ficheiro estiver atualmente aberto, o resultado depende do sistema operativo:
- no Windows, é gerado um erro,
- no macOS, não é gerado qualquer erro e o ficheiro é eliminado.
.delete()
pode apagar qualquer ficheiro num disco. Isto inclui documentos criados com outras aplicações, bem como as próprias aplicações. .delete()
deve ser usado com extrema cautela. A eliminação de um arquivo é uma operação permanente e não pode ser desfeita.
Exemplo
Se quiser apagar um ficheiro específico na pasta da base de dados:
$tempo:=File("/PACKAGE/SpecialPrefs/"+Current user+".prefs")
If($tempo.exists)
$tempo.delete()
ALERT("User preference file deleted.")
End if
.exists
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.exists : Boolean
Descrição
The .exists
property returns true if the file exists on disk, and false otherwise.
Essa propriedade é somente leitura.
.extension
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.extension : Text
Descrição
The .extension
property returns the extension of the file name (if any). Uma extensão sempre começa com ".". Uma extensão sempre começa com "." A propriedade devolve uma string vazia se o nome do arquivo não tiver extensão.
Essa propriedade é somente leitura.
.fullName
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.fullName : Text
Descrição
The .fullName
property returns the full name of the file, including its extension (if any).
Essa propriedade é somente leitura.
.getAppInfo()
História
Release | Mudanças |
---|---|
19 | Adicionado |
.getAppInfo() : Object
Parâmetro | Tipo | Descrição | |
---|---|---|---|
Resultados | Object | <- | Conteúdo do arquivo de versão recurso .exe/.dll ou .plist |
Descrição
A função .getAppInfo()
retorna o conteúdo de um arquivo .exe, .dll ou .plist como um objeto.
A função deve ser utilizada com um arquivo .exe, .dll ou .plist existente. Se o arquivo não existir no disco ou não for um ficheiro .exe, .dll ou .plist válido, a função devolve um objecto vazio (não é gerado nenhum erro).
A função apenas é compatível com arquivos .plist em formato xml (baseado em texto). Um erro é retornado se usado com um arquivo .plist em formato binário.
Objeto devolvido com um arquivo .exe ou .dll
A leitura de um .exe ou .dll só é possível no Windows.
Todos os valores de propriedades são Texto.
Propriedade | Tipo |
---|---|
InternalName | Text |
ProductName | Text |
CompanyName | Text |
LegalCopyright | Text |
ProductVersion | Text |
FileDescription | Text |
FileVersion | Text |
OriginalFilename | Text |
Objeto devolvido com um arquivo .split
O conteúdo xml do arquivo é analisado e as chaves são devolvidas como propriedades do objeto, preservando os seus tipos (texto, booleano, número). .plist dict
é retornado como um objeto JSON e o .plist array
é retornado como um array JSON.
Exemplo
// exibir informações de direitos autorais do arquivo .exe do aplicativo (Windows)
var $exeFile : 4D.File
var $info : Object
$exeFile:=File(Application file; fk platform path)
$info:=$exeFile.getAppInfo()
ALERT($info.LegalCopyright)
// exibe informações de copyright de um info.plist (qualquer plataforma)
var $infoPlistFile : 4D.File
var $info : Object
$infoPlistFile:=File("/RESOURCES/info.plist")
$info:=$infoPlistFile.getAppInfo()
ALERT($info.Copyright)
Veja também
.getContent()
História
Release | Mudanças |
---|---|
19 R2 | Returns 4D. Blob |
17 R5 | Adicionado |
.getContent( ) : 4D.Blob
Parâmetro | Tipo | Descrição | |
---|---|---|---|
Resultados | 4D. Blob | <- | Conteúdo do arquivo |
Descrição
The .getContent()
function returns a 4D.Blob
object containing the entire content of a file. Para obter informações sobre BLOBs, consulte a seção BLOB.
Valor retornado
Um objeto 4D.Blob
.
Exemplo
Para salvar o conteúdo de um documento em um campo BLOB
:
var $vPath : Text
$vPath:=Select document(""; "*"; "Select a document";0)
If(OK=1) //Se tiver sido escolhido um documento
[aTable]aBlobField:=File($vPath;fk platform path).getContent()
End if
.getIcon()
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.getIcon( { size : Integer } ) : Picture
Parâmetro | Tipo | Descrição | |
---|---|---|---|
size | Integer | -> | Longitude de lado da imagem devolvida (píxeles) |
Resultados | Imagem | <- | Ícone |
Descrição
The .getIcon()
function returns the icon of the file.
The optional size parameter specifies the dimensions in pixels of the returned icon. Este valor representa em realidade a longitude do lado do quadrado que contém o icone. Icones são geralmente definidos como 32x32 píxels ('icones grandes') ou 16x16 ('icones pequenos'). Se passar 0 ou omitir este parâmetro, se devolve a versão 'icone grande'
Se o arquivo não existir no disco, um ícone em branco padrão será retornado.
Valor retornado
Imagen do ícone de arquivo.
.getText()
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.getText( { charSetName : Text { ; breakMode : Integer } } ) : Text
.getText( { charSetNum : Integer { ; breakMode : Integer } } ) : Text
Parâmetro | Tipo | Descrição | |
---|---|---|---|
charSetName | Text | -> | Nome do conjunto de caracteres |
charSetNum | Integer | -> | Número de conjuntos de caracteres |
breakMode | Integer | -> | Modo de processamento para quebras de linha |
Resultados | Text | <- | Texto do documento |
Descrição
The .getText()
function returns the contents of the file as text .
Opcionalmente, você pode designar o conjunto de caracteres a ser usado na leitura do conteúdo. Você pode passar também:
- in charSetName, a string containing the standard set name (for example "ISO-8859-1" or "UTF-8"),
- ou em charSetNum, o MIBEnum ID (número) do nome de configuração padrão.
For the list of character sets supported by 4D, refer to the description of the
CONVERT FROM TEXT
command.
If the document contains a Byte Order Mark (BOM), 4D uses the character set that it has set instead of the one specified in charSetName or charSetNum (this parameter is then ignored). If the document does not contain a BOM and if charSetName or charSetNum is omitted, by default 4D uses the "UTF-8" character set.
In breakMode, you can pass a number indicating the processing to apply to end-of-line characters in the document. As seguintes constantes do tema "Documentos do Sistema" estão disponíveis:
Parâmetros | Valor | Comentário |
---|---|---|
Document unchanged | 0 | Não processado |
Document with native format | 1 | (Padrão) As quebras de linha são convertidas para o formato nativo do sistema operacional: CR (retorno de carro) sob OS X, CRLF (retorno do carro + salto de linha) em Windows |
Documento com CRLF | 2 | Quebras de linha são convertidas em formato Windows: CRLF (retorno de carro + quebra de linha) |
Documento com CR | 3 | Quebras de linha são convertidas para o formato OS X: CR (retorno de carro) |
Documento com LF | 4 | Quebras de linha são convertidas em formato Unix: LF (feed de linha) |
By default, when you omit the breakMode parameter, line breaks are processed in native mode (1).
Valor retornado
Texto do arquivo.
Exemplo
Dado o seguinte documento de texto (os campos são separados por tabulações):
id name price vat
3 thé 1.06€ 19.6
2 café 1.05€ 19.6
Quando você executar este código:
$myFile:=Folder(fk documents folder).file("Billing.txt") //UTF-8 por padrão
$txt:=$myFile.getText()
... você obtém o seguinte para $txt
:
"id\tname\tprice\tvat\r\n3\tthé\t1.06€\t19.6\r\n2\tcafé\t1.05€\t19.6"
with \t
(tab) as separator and \r\n
(CRLF) as line delimiter.
Aqui está outro exemplo com o mesmo arquivo, mas um delimitador de linha diferente:
$txt:=$myFile.getText("UTF-8"; Document with LF)
Neste caso, o conteúdo de $txt
é o seguinte:
"id\tname\tprice\tvat\n3\tthé\t1.06€\t19.6\n2\tcafé\t1.05€\t19.6"
Este tempo \n
(LF) é usado como delimitador de linha.
.hidden
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.hidden : Boolean
Descrição
The .hidden
property returns true if the file is set as "hidden" at the system level, and false otherwise.
Essa propriedade é leitura/escrita.
.isAlias
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.isAlias : Boolean
Descrição
The .isAlias
property returns true if the file is an alias, a shortcut, or a symbolic link, and false otherwise.
Essa propriedade é somente leitura.
.isFile
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.isFile : Boolean
Descrição
The .isFile
property returns always true for a file.
Essa propriedade é somente leitura.
.isFolder
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.isFolder : Boolean
Descrição
The .isFolder
property returns always false for a file.
Essa propriedade é somente leitura.
.isWritable
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.isWritable : Boolean
Descrição
The .isWritable
property returns true if the file exists on disk and is writable.
The property checks the ability of the 4D application to write on the disk (access rights), it does not solely rely on the writable attribute of the file.
Essa propriedade é somente leitura.
Exemplo
$myFile:=File("C:\\Documents\\Archives\\ReadMe.txt";fk platform path)
If($myFile.isWritable)
$myNewFile:=$myFile.setText("Added text")
End if
.modificationDate
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.modificationDate : Date
Descrição
The .modificationDate
property returns the date of the file's last modification.
Essa propriedade é somente leitura.
.modificationTime
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.modificationTime : Time
Descrição
The .modificationTime
property returns the time of the file's last modification (expressed as a number of seconds beginning at 00:00).
Essa propriedade é somente leitura.
.moveTo()
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.moveTo( destinationFolder : 4D.Folder { ; newName : Text } ) : 4D.File
Parâmetro | Tipo | Descrição | |
---|---|---|---|
destinationFolder | 4D. Folder | -> | Pasta de destino |
newName | Text | -> | Nome completo do ficheiro movido |
Resultados | 4D. File | <- | Arquivo movido |
Descrição
A função .moveTo()
move ou renomeia o objeto File
para a destinationFolder especificada.
A destinationFolder deve existir em disco, senão um erro é gerado.
Por padrão, o arquivo mantém o seu nome quando é movido. Se quiser renomear o arquivo movido, passe o novo nome completo no parâmetro newName. O novo nome deve cumprir com as regras de nomenclatura (por exemplo, não deve conter caracteres como ":", "/", etc.), do contrário se devolve um erro.
Objeto devolvido
O objeto File
movido.
Exemplo
$DocFolder:=Folder(fk documents folder)
$myFile:=$DocFolder.file("Current/Infos.txt")
$myFile.moveTo($DocFolder.folder("Archives");"Infos_old.txt")
.name
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.name : Text
Descrição
The .name
property returns the name of the file without extension (if any).
Essa propriedade é somente leitura.
.open()
História
Release | Mudanças |
---|---|
18 R6 | Adicionado |
.open( { mode : Text } ) : 4D.FileHandle
.open( { options : Object } ) : 4D.FileHandle
Parâmetro | Tipo | Descrição | |
---|---|---|---|
mode | Text | -> | Modo de abertura: "read", "write", "append" |
options | Object | -> | Opções de abertura |
Resultados | 4D.FileHandle | <- | Novo objeto File handle |
Descrição
A função .open()
cria e retorna um novo objeto 4D.FileHandle no arquivo, no mode especificado ou com as options especificadas. Pode utilizar funções e propriedades da classe 4D.FileHandle para escrever, ler ou anexar conteúdo ao arquivo.
Se utilizar o parâmetro mode (text), passe o modo de abertura para o file handle:
mode | Descrição |
---|---|
"read" | (Padrão) Cria um file handle para ler os valores do arquivo. Se o arquivo não existir em disco, um erro é retornado. Pode abrir quantos file handles quiser em modo "ler" no mesmo objeto File. |
"write" | Cria um file handle para escrever os valores no arquivo (começando no início do conteúdo do arquivo). Se o arquivo não existir em disco, é criado. Só se pode abrir um único file handle em modo "write" no mesmo objeto File. |
"append" | Cria um file handle para escrever os valores no arquivo (começando no fim do conteúdo do arquivo). Se o arquivo não existir em disco, é criado. Só se pode abrir um único file handle em modo "append" no mesmo objeto File. |
O valor de modo diferencia maiúsculas de minúsculas.
Se você usar o parâmetro options (objeto), poderá passar mais opções para o identificador de arquivo por meio das seguintes propriedades (essas propriedades podem ser lidas posteriormente a partir do objeto de identificador de arquivo aberto):
opções | Tipo | Descrição | Por padrão |
---|---|---|---|
.mode | Text | Modo de abertura (consulte modo acima) | "read" |
.charset | Text | Conjunto de carateres utilizado para ler ou escrever no ficheiro. Utilizar o nome padrão do conjunto (por exemplo "ISO-8859-1" ou "UTF-8") | "UTF-8" |
.breakModeRead | Text ou Number | Modo de tratamento das quebras de linha utilizadas na leitura do arquivo (veja abaixo) | "native" ou 1 |
.breakModeWrite | Text ou Number | Modo de processamento das quebras de linha utilizadas ao escrever no ficheiro (ver abaixo) | "native" ou 1 |
A função substitui todos os delimitadores de fim de linha originais. Por defeito, é utilizado o delimitador nativo, mas é possível definir outro delimitador. .breakModeRead
e o .breakModeWrite
indicam o processamento a ser aplicado aos caracteres de fim de linha no documento. Pode utilizar um dos seguintes valores (texto ou número):
Modo de interrupção no texto | Break mode em numérico (constante) | Descrição |
---|---|---|
"native" | 1 (Document with native format ) | (Padrão) As quebras de linha são convertidas para o formato nativo do sistema operativo: LF (avanço de linha) no macOS, CRLF (retorno de carro + avanço de linha) no Windows |
"crlf" | 2 (Document with CRLF ) | As quebras de linha são convertidas em CRLF (retorno de carro + avanço de linha), o formato predefinido do Windows |
"cr" | 3 (Document with CR ) | As quebras de linha são convertidas em CR (carriage return), o formato padrão do Mac OS |
"lf" | 4 (Document with LF ) | As quebras de linha são convertidas para LF (line feed), o formato padrão Unix e macOS |
O valor break mode as text diferencia maiúsculas de minúsculas.
Exemplo
Pretende criar um file handle para a leitura do ficheiro "ReadMe.txt":
var $f : 4D.File
var $fhandle : 4D.FileHandle
$f:=File("C:\\Documents\\Archives\\ReadMe.txt";fk platform path)
$fhandle:=$f.open("read")
.original
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.original : 4D.File
.original : 4D.Folder
Descrição
The .original
property returns the target element for an alias, a shortcut, or a symbolic link file. O elemento alvo pode ser:
- um objeto File
- um objeto folder
Para arquivos não-alias, a propriedade retorna o mesmo objeto de arquivo que o arquivo.
Essa propriedade é somente leitura.
.parent
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.parent : 4D.Folder
Descrição
The .parent
property returns the parent folder object of the file. .
Essa propriedade é somente leitura.
.path
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.path : Text
Descrição
The .path
property returns the POSIX path of the file. .
Essa propriedade é somente leitura.
.platformPath
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.platformPath : Text
Descrição
The .platformPath
property returns the path of the file expressed with the current platform syntax.
Essa propriedade é somente leitura.
.rename()
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.rename( newName : Text ) : 4D.File
Parâmetro | Tipo | Descrição | |
---|---|---|---|
newName | Text | -> | Novo nome completo para o ficheiro |
Resultados | 4D. File | <- | Ficheiro renomeado |
Descrição
The .rename()
function renames the file with the name you passed in newName and returns the renamed File
object.
The newName parameter must comply with naming rules (e.g., it must not contain characters such as ":", "/", etc.), otherwise an error is returned. Se já existir um ficheiro com o mesmo nome, é devolvido um erro.
Note that the function modifies the full name of the file, i.e. if you do not pass an extension in newName, the file will have a name without an extension.
Objeto devolvido
O objeto File
renomeado.
Exemplo
Se quiser renomear "ReadMe.txt" em "ReadMe_new.txt":
$toRename:=File("C:\\Documents\\Archives\\ReadMe.txt";fk platform path)
$newName:=$toRename.rename($toRename.name+"_new"+$toRename.extension)
.setAppInfo()
História
Release | Mudanças |
---|---|
20 | Suporte de WinIcon |
19 | Adicionado |
.setAppInfo( info : Object )
Parâmetro | Tipo | Descrição | |
---|---|---|---|
info | Object | -> | Propriedades para escrever no arquivo .plist ou o recurso versão do arquivo .exe/.dll |
Descrição
A função .setAppInfo()
escreve as propriedades info como o conteúdo da informação de um arquivo .exe, .dll ou .plist .
A função deve ser utilizada com um arquivo .exe, .dll ou .plist existente. Se o ficheiro não existir no disco ou não for um ficheiro .exe, .dll ou .plist válido, a função não faz nada (não é gerado qualquer erro).
A função apenas é compatível com arquivos .plist em formato xml (baseado em texto). Um erro é retornado se usado com um arquivo .plist em formato binário.
*Parâmetro info com um arquivo .exe ou .dll
A escrita de um arquivo .exe ou .dll só é possível no Windows.
Each valid property set in the info object parameter is written in the version resource of the .exe or .dll file. As propriedades disponíveis são (qualquer outra propriedade será ignorada):
Propriedade | Tipo | Comentário |
---|---|---|
InternalName | Text | |
ProductName | Text | |
CompanyName | Text | |
LegalCopyright | Text | |
ProductVersion | Text | |
FileDescription | Text | |
FileVersion | Text | |
OriginalFilename | Text | |
WinIcon | Text | Caminho Posix do ficheiro .ico. Esta propriedade aplica-se apenas a ficheiros executáveis gerados por 4D. |
For all properties except WinIcon
, if you pass a null or empty text as value, an empty string is written in the property. Se passar um tipo de valor diferente de texto, este é transformado em string.
For the WinIcon
property, if the icon file does not exist or has an incorrect format, an error is generated.
*Parâmetro info com um arquivo .plist
Each valid property set in the info object parameter is written in the .plist file as a key. Qualquer nome chave é aceito. Os tipos de valores são preservados sempre que possível.
If a key set in the info parameter is already defined in the .plist file, its value is updated while keeping its original type. Outras chaves existentes no arquivo .plist são deixadas intocadas.
Para definir um valor de tipo de data, o formato a utilizar é uma string de carimbo temporal json formada em ISO UTC sem milissegundos ("2003-02-01T01:02:03Z") como no editor plist de Xcode.
Exemplo
// set copyright and version of a .exe file (Windows)
var $exeFile : 4D. File
var $info : Object
$exeFile:=File(Application file; fk platform path)
$info:=New object
$info. LegalCopyright:="Copyright 4D 2021"
$info. ProductVersion:="1.0.0"
$exeFile.setAppInfo($info)
// set some keys in an info.plist file (all platforms)
var $infoPlistFile : 4D. File
var $info : Object
$infoPlistFile:=File("/RESOURCES/info.plist")
$info:=New object
$info. Copyright:="Copyright 4D 2021" //text
$info. ProductVersion:=12 //integer
$info. ShipmentDate:="2021-04-22T06:00:00Z" //timestamp
$infoPlistFile.setAppInfo($info)
Veja também
.setContent()
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.setContent ( content : Blob )
Parâmetro | Tipo | Descrição | |
---|---|---|---|
content | BLOB | -> | Novos conteúdos para o arquivo |
Descrição
The .setContent( )
function rewrites the entire content of the file using the data stored in the content BLOB. Para obter informações sobre BLOBs, consulte a seção BLOB.
Exemplo
$myFile:=Folder(fk documents folder).file("Archives/data.txt")
$myFile.setContent([aTable]aBlobField)
.setText()
História
Release | Mudanças |
---|---|
19 R3 | Padrão para novos projectos: sem BOM e (macOS) LF para EOL |
17 R5 | Adicionado |
.setText ( text : Text {; charSetName : Text { ; breakMode : Integer } } )
.setText ( text : Text {; charSetNum : Integer { ; breakMode : Integer } } )
Parâmetro | Tipo | Descrição | |
---|---|---|---|
text | Text | -> | Texto a armazenar no arquivo |
charSetName | Text | -> | Nome do conjunto de caracteres |
charSetNum | Integer | -> | Número de conjuntos de caracteres |
breakMode | Integer | -> | Modo de processamento para quebras de linha |
Descrição
The .setText()
function writes text as the new contents of the file.
If the file referenced in the File
object does not exist on the disk, it is created by the function. Quando o ficheiro já existir no disco, o seu conteúdo anterior é apagado, exceto se já estiver aberto, caso em que o seu conteúdo é bloqueado e é gerado um erro.
Em text, passe o texto a escrever no arquivo. Pode ser um texto literal ("my text"), ou um campo/variável texto 4D.
Opcionalmente, pode designar o conjunto de caracteres a utilizar para escrever o conteúdo. Você pode passar também:
- in charSetName, a string containing the standard set name (for example "ISO-8859-1" or "UTF-8"),
- ou em charSetNum, o MIBEnum ID (número) do nome de configuração padrão.
For the list of character sets supported by 4D, refer to the description of the
CONVERT FROM TEXT
command.
Se uma marca de ordem de byte (BOM) existe para o conjunto de caracteres, 4D a insere no ficheiro a menos que o conjunto de caracteres usado contenha o sufixo "-no-bom" (por exemplo, "UTF-8-no-bom"). Se não especificar um conjunto de caracteres, por defeito 4D usa o conjunto de caracteres "UTF-8" sem BOM.
In breakMode, you can pass a number indicating the processing to apply to end-of-line characters before saving them in the file. Estão disponíveis as seguintes constantes, encontradas no tema System Documents:
Parâmetros | Valor | Comentário |
---|---|---|
Document unchanged | 0 | Não processado |
Document with native format | 1 | (Padrão) As quebras de linha são convertidas para o formato nativo do sistema operativo: LF (avanço de linha) no macOS, CRLF (retorno de carro + avanço de linha) no Windows |
Documento com CRLF | 2 | As quebras de linha são convertidas em CRLF (retorno de carro + avanço de linha), o formato predefinido do Windows |
Documento com CR | 3 | As quebras de linha são convertidas em CR (carriage return), o formato padrão do Mac OS |
Documento com LF | 4 | As quebras de linha são convertidas para LF (line feed), o formato padrão Unix e macOS |
By default, when you omit the breakMode parameter, line breaks are processed in native mode (1).
Nota de compatibilidade: as opções de compatibilidade estão disponíveis para a gerenciamento da EOL e da BOM. Consulte a página Compatibilidade em doc.4d.com.
Exemplo
$myFile:=File("C:\\Documents\\Hello.txt";fk platform path)
$myFile.setText("Hello world")
.size
História
Release | Mudanças |
---|---|
17 R5 | Adicionado |
.size : Real
Descrição
The .size
property returns the size of the file expressed in bytes. Se o arquivo não existir em disco, o tamanho é 0.
Essa propriedade é somente leitura.