Compacta um arquivo do ambiente do servidor, a partir do rootpath, para um arquivo no formato gzip.
Sintaxe
GzCompress( < cFile >, [ cGzip ], [ lChangeCase ] )
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Referência |
---|---|---|---|---|
cFile | caractere | Indica o arquivo no servidor que será compactado. | X |
|
cGzip | caractere | Indica o nome do arquivo compactado. |
|
|
lChangeCase | lógico | Indica se colocará o nome dos arquivos em letra minúscula. |
|
|
Retorno
Nome | Tipo | Descrição |
---|---|---|
lRet | lógico | Retorna .T. se a compactação for realizada com sucesso; caso contrário, retorna .F.. |
Observações
- Essa função compacta um único arquivo para o formato gzip (GNU zip).
- Para compactar mais de um arquivo usando o formato gzip, agrupe os arquivos utilizando a função TarCompress e utilize o arquivo de saída no parâmetro cFile da função GzCompress.
- Caso seja passado algum arquivo no cliente, é gerada uma exceção com a mensagem: "Only path on server are allowed".
- GzCompress trabalha somente com arquivos e diretórios localizados no servidor (a partir do RootPath do ambiente). Caso o nome do arquivo de destino, apontado pelo parâmetro <cGzip>, não seja válido, é gerada uma exceção com a mensagem: "File name invalid".
- Caso o nome do arquivo de destino não seja especificado, cGzip será o nome do arquivo apontado pelo parâmetro cFile seguido da extensão gz (".gz").
- Os caminhos apontados por cFile e cGzip serão convertidos para letra minúscula. A partir da build 7.00.121227A, os caminhos não serão convertidos para letra minúscula para Logix.
- A partir da build 7.00.131227A foi criado o parâmetro lChangeCase, que se for definido com o valor .T., altera o nome dos arquivos para letra minúscula, e se for .F. não altera o nome dos arquivos. O valor padrão do parâmetro é .T..
- Em ambiente Windows, os nomes de arquivos não possuem diferenciação entre maiúsculo e minúsculo, logo, a função conseguirá tratar os arquivos apontados por cFile e cGzip independente do valor definido no parâmetro lChangeCase. Em ambiente Linux ou Mac, o nome dos arquivos respeita a diferenciação.
Exemplos
Exemplo 1
user function exemplo() local lGzCompress := .F. // cria o arquivo gzip lGzCompress := GzCompress( "\file1.txt", "\testdir\file.gz" ) return
Veja também
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas