TOTVSTEC

Árvore de páginas

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

Se verdadeiro (.T.), nomes de arquivos e pastas serão convertidos para letras minúsculas; caso contrário, falso (.F.), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão (.T.). Veja maiores informações em Observações.

 

 

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").
  • O parâmetro opcional lChangeCase foi introduzido a partir do build 7.00.131227A pois em sistemas LINUX/UNIX, existe a diferenciação entre maiúsculo e minúsculo em nomes de arquivos ou pastas. Quando este parâmetro for informado, terá prioridade sobre comportamento de Case Sensitive definido pelas chaves de ini CASESENSITIVE ou SERVERTYPE. Porem, quando não especificado o parâmetro, o valor padrão (.T.) fica condicionado ao que está configurado nessas chaves.
  • 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.

Exemplos

user function exemplo()
local lGzCompress := .F.

// cria o arquivo gzip
lGzCompress := GzCompress( "\file1.txt", "\testdir\file.gz" )
return

Veja também

  • Sem rótulos