Exibir origem

Lista os arquivos que estão dentro do arquivo compactado em formato Zip.

Sintaxe

FListZip( < cZipFile >, [ @nRet ], [ cPassword ], [ lChangeCase ] )

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
cZipFile	character	Indica o nome do arquivo compactado.	X
nRet	numeric	Retorna 0, se retornou corretamente a lista de arquivos; diferente de 0, se aconteceu algum erro.		X
cPassword	character	Senha que foi utilizada na compactação.
lChangeCase	logical	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
aRet	array	Retorna uma lista com os nomes e tamanhos dos arquivos compactados.

Observações

Arquivo pode estar no servidor (RootPath) ou no cliente (caminho completo).
Caso o arquivo apontado em cZipFile esteja no Cliente e o programa seja executado via Job, o programa será encerrado com a ocorrência de erro fatal "Function FListZip() cannot access client directory/file in Job.".
O caminho apontado em cZipFile não é convertido para minúsculo, sendo tratado da forma como é escrito. Dessa forma, em Windows não existe impacto no acesso aos arquivos e pastas, mas em Linux, devido ao sistema operacional diferenciar caminhos em maiúsculo e minúsculo, pode não conseguir acessar o caminho, devendo ser escrito com o Case Sensitive correto.
O parâmetro opcional lChangeCase foi introduzido a partir da versão 24.3.0.0 do 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.

A partir da versão 24.3.0.0 do a função por padrão irá converter o caminho informado em cZipFile para minúsculo, mantendo o comportamento existente em todas as funções que tratam arquivos. Em versões anteriores, o caminho informado não é alterado.

Exemplos

user function exemplo()
  Local nRet := 10
  Local aRet := FListZip( "\testing\imagens.zip", @nRet )
  
  if nRet == 0
    varinfo( "aRet", aRet ) // Mostra no console o conteúdo do array
  else
    conout( "Erro: " + cValToChar( nRet ) )
  endif
return

Abrangência