FS_CLEAR_DIR

Elimina todos os arquivos de um diretório do sistema de arquivos (SDCARD), sem remover os sub-diretórios contidos nele. É um bloco de função (mantém estado entre scans; requer instância).

Biblioteca: HI_STD · Namespace: HILS · Tipo: bloco de função

Bloco de função

             FS_CLEAR_DIR
           +--------------+
  BOOL ----|START     DONE|---- BOOL
           |              |
           |        RESULT|---- INT
           |              |
STRING ----|NAME -------- |----
           +--------------+

A operação é iniciada colocando START em TRUE. Ao término, o bloco emite um pulso de um scan em DONE e disponibiliza o código de retorno em RESULT. Todos os arquivos do diretório indicado em NAME são eliminados; os sub-diretórios existentes são mantidos inalterados.

Nota

Antes de utilizar este bloco de função, consulte no manual do controlador utilizado se o mesmo possui suporte para sistema de arquivos no SDCARD.

Nota

Os arquivos a serem removidos não podem possuir nenhum acesso de leitura e/ou escrita ativo no momento da chamada.

Parâmetros

Nome	Direção	Tipo	Padrão	Faixa / Unidade	Descrição
START	IN	BOOL	FALSE	—	Ativa a execução (TRUE). Voltar a FALSE antes do fim reseta o bloco.
NAME	IN_OUT	STRING	—	máx. 64 caracteres	Caminho completo do diretório cujos arquivos serão eliminados. Deve iniciar com `/` (raiz). Ex.: `/DADOS`, `/RECEITAS/AZUL`.
DONE	OUT	BOOL	FALSE	—	Pulso de fim de execução (ativo por um scan); consulte `RESULT` neste ciclo.
RESULT	OUT	INT	0	RET_CODE	Código de retorno da execução (ver Códigos de retorno).

Códigos de retorno

RESULT é do tipo RET_CODE. Use os identificadores com o namespace HILS (ex.: HILS.FS_NOTFOUND). Códigos mais comuns deste bloco:

Código	Identificador	Significado
0	SUCCESS	Função executada com sucesso.
5	GL_INV_PAR	Parâmetro(s) inválido(s).
7	GL_UNA_CMD	Comando não disponível ou não implementado.
8	GL_INV_STT	Estado corrente inválido.
10	GL_CMD_TMO	Timeout na execução do comando.
11	GL_CMD_CAN	Comando cancelado.
16	GL_CMD_PEND	Tratamento do comando pendente.
24	RE_NOT_AVA	Sem suporte para o sistema de arquivos ou SDCARD não detectado.
25	RE_INV_LEN	Tamanho especificado no parâmetro `NAME` inválido.
33	RE_NOT_INIT	Recurso não inicializado.
167	FS_CORRUPT	Sistema de arquivo pode estar corrompido.
173	FS_INVALIDNAME	Texto especificado no parâmetro `NAME` inválido.
174	FS_NOTFOUND	O arquivo/diretório não foi encontrado.

Lista completa dos códigos de retorno: RET_CODE - Códigos de retorno do firmware G5.

Pré-condições

O controlador deve possuir suporte a sistema de arquivos em SDCARD.
NAME deve conter o caminho completo do diretório, iniciando com / e com no máximo 64 caracteres.
Nenhum arquivo do diretório pode estar com acesso de leitura/escrita ativo.

Observações

Os sub-diretórios contidos no diretório especificado não são eliminados.
DONE fica ativo por apenas um scan; leia RESULT nesse mesmo ciclo.

Recomendações para nomes de arquivos e diretórios:

Apesar do sistema de arquivos aceitar qualquer caracter para definição de um nome de arquivo ou diretório, recomenda-se utilizar apenas os tipos:

Caracteres alfabéticos de A-Z ou a-z

Caracteres numéricos de 0 - 9

Caracteres especiais . (ponto decimal) ou _ (underline)

O tamanho máximo permitido para nome do arquivo ou diretório é de 64 caracteres.

Apesar de permitir caracteres em minúscula e maiúscula na nomenclatura, o sistema não é “case sensitive”, ou seja, os nomes ‘DADOS.DAT’, ‘Dados.Dat’ e ‘dados.dat’ referem-se ao mesmo arquivo.

Essa recomendação é sugerida, pois quando o arquivo for eventualmente transferido para o computador, o arquivo/diretório deve obedecer as regras de nomeação do sistema operacional do PC.

Exemplos de nomes recomendados:

‘PASTA’

‘/Pasta_1/Pasta_2’

‘dados.dat’

‘abc_123.txt’

Exemplos de nomes não recomendados:

‘teste abc’

‘áãç’

‘abc’ e ‘ABC’ (considerados como o mesmo arquivo pelo sistema operacional windows)

Instruções de acesso para arquivos e diretórios:

O diretório inicial default do sistema de arquivo é o diretório raiz.

Para acessar diretamente o diretório raiz, utilizar ‘/’ antes do nome do arquivo ou diretório.

Exemplos de caminho completo para diretórios:

‘/’ : Diretório raiz do sistema de arquivo
‘/PASTA_1’ : Diretório “PASTA_1” localizado na raiz do sistema de arquivo
‘/PASTA_1/PASTA_2’ : Caminho completo para diretório “PASTA_2” a partir da “PASTA_1” localizado na raiz do sistema de arquivo
‘/p1/p2/p3’ : Caminho completo para diretório “p3” a partir dos diretórios “/p1/p2”

Exemplos de caminho completo para arquivos:

‘/dados.dat’ : Arquivo “dados.dat” localizado na raiz do sistema de arquivo
‘/PASTA_1/Log.dat’ : Arquivo “Log.dat” localizado dentro do diretório “/PASTA_1”
‘/DADOS/Jan/Dados.bak’ : Arquivo “Dados.bak” localizado dentro dos diretórios “/DADOS/Jan”
‘/P1/P2/P3/SETUP.CFG’ : Arquivo “SETUP.CFG” localizado dentro dos diretórios “/P1/P2/P3”

Ver também

FS_DELETE_FILE_DIR, FS_CREATE_DIR, FS_LIST_DIR

Exemplo

Clique aqui para baixar a tabela de variáveis

Código ST

VAR
    DIR_DADOS : STRING := '/DADOS'; (* Constante string com o nome do diretório a ser eliminado os arquivos *)
    MY_START  : BOOL := FALSE;      (* Ativação da função *)
    DIR_NAME  : STRING;             (* Nome do diretório a ser eliminado os arquivos *)
    CLEAR_DIR : HILS.FS_CLEAR_DIR;  (* Instancia do bloco "FS_CLEAR_DIR" *)
END_VAR

//======================================================
// Exemplo 1 : Elimina arquivos de diretório na raiz
//======================================================
//
// Elimina arquivos do diretorio '/DADOS', localizado raiz do sistema

DIR_NAME := DIR_DADOS; // string com o caminho completo para o diretório '/DADOS' na raiz

(* ... *)

//======================================================
// Exemplo 2 : Elimina arquivos na raiz do sistema de arquivo
//======================================================
//
// Elimina arquivos do diretorio raiz '/' do sistema de arquivos

DIR_NAME := '/';    // string com o diretório raiz do sistema de arquivo

(* ... *)

//======================================================
// Exemplo 3 : Elimina arquivos dentro de um diretório
//======================================================
//
// Elimina arquivos do diretorio 'P3', localizado dentro dos diretorios '/P1/P2'

DIR_NAME := '/P1/P2/P3';  // string com o caminho completo para o diretório P3

(* ... *)

//============================================================================
// Trata função FS_CLEAR_DIR
//============================================================================

// Preenche demais parâmetros para a chamada do bloco de função
MY_START := TRUE;        // Ativação do bloco da função

(* ... *)

// Exemplo de ativação do bloco de função FS_CLEAR_DIR
CLEAR_DIR(
  START := MY_START,  // [BOOL] Ativação da função
  NAME  := DIR_NAME   // [STRING] Caminho completo com nome do diretório a ser eliminado os arquivos
  );

// Aguarda término da execução da função do sistema de arquivos
if (CLEAR_DIR.DONE) then

  MY_START := FALSE;     // reseta ativação da função

  // Testa código de retorno da execução da função
  if (CLEAR_DIR.RESULT = HILS.SUCCESS) then
    // ... Função executada com sucesso
  else
    // ... Erro na execução da função
  end_if;

end_if;

(* ... *)