xFunGetDir - Realiza a Manipulação de Arquivos

01. DADOS GERAIS

Produto:	TOTVS Backoffice
Linha de Produto:	Linha Protheus
Segmento:	Backoffice
Módulo:	Livros Fiscais

02. DESCRIÇÃO

Função genérica utilizada para geração e/ou cópia de arquivos entre Server e Remote.

Foi concebida para facilitar a geração de arquivos, por exemplo arquivos .TXT, .XML, entre outros.

Possui as regras de integração entre Server e Remote,. Exemplo: Quando tratar-se de ambiente Linux os tratamentos de adaptação já são feitos internamente pela função.

Utiliza as funções padrões para cópia dos arquivos do server para diretório específico, por exemplo: SplitPath(), MsCopyFile(), CpyS2T(), CpyT2S().

03. ESPECIFICAÇÃO

Parâmetros da função:

Variável	Tipo	Descrição	Obrigatório
nOpc	Numérico	Opção que será utilizada na função: 1: Criação do arquivo no Startpath 2: Libera handle do arquivo através de FClose() 3: Realiza cópia do arquivo para diretório especifico ou realiza leitura de arquivo;	Sim
cFile	Caractere	Path do arquivo a ser criado
cArq	Caractere	Arquivo criado pela CriaTrab() - pode ser enviado o nome do arquivo ou enviar Nil para que a função efetue o tratamento
cStartPath	Caractere	Startpath do ambiente (enviar como parâmetro o StartPath ou enviar Nil para que a função encontre - no último caso enviar como referência)
nHandle	Numérico	Acesso ao arquivo.
lReadFile	Lógico	Indica leitura de arquivo (enviar T quando deseja que o server faça a cópia do arquivo para manipulação)
cNewFile	Caractere	Nome do arquivo gerado pela função (enviar como referência; o retorno será o arquivo copiado para o server; utilizar quando lReadFile = .T.)

Retorno:

Tipo

Descrição

Lógico

Quando .T. Processo executado com sucesso;

Quando .F. houve falha no processo (quando houver alguma falha a própria função mostra um alerta na tela com o erro).

04. EXEMPLO DE UTILIZAÇÃO

05. INFORMAÇÕES ADICIONAIS

Não há

Árvore de páginas