FS_DELETE_FILE_DIR

Elimina um arquivo ou diretório no sistema de arquivos do SDCARD do controlador. Para remover um arquivo ele não pode ter nenhum acesso de leitura/escrita ativo e, para remover um diretório, ele deve estar vazio. É 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_DELETE_FILE_DIR
           +--------------+
  BOOL ----|START     DONE|---- BOOL
           |              |
           |        RESULT|---- INT
           |              |
STRING ----|NAME -------- |----
           +--------------+

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.

A operação é iniciada colocando START em TRUE. Se START retornar a FALSE antes do término, o bloco é resetado. Ao concluir, DONE gera um pulso de um único scan e o resultado da execução deve então ser lido em RESULT.

NAME recebe o caminho completo (a partir da raiz /) do arquivo ou diretório a ser eliminado, limitado a 64 caracteres.

Parâmetros

Nome	Direção	Tipo	Padrão	Faixa / Unidade	Descrição
START	IN	BOOL	FALSE	—	Ativação da função. `TRUE` inicia a execução; `FALSE` antes do término reseta o bloco.
NAME	IN_OUT	STRING	—	até 64 caracteres	Caminho completo (a partir de `/`) com o nome do arquivo/diretório a ser eliminado.
DONE	OUT	BOOL	FALSE	—	Pulso de um scan indicando o fim da execução; nesse instante leia `RESULT`.
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.SUCCESS). 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.
13	GL_FUNC_FAIL	Falha na execução da função.
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 em `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 em `NAME` inválido.
174	FS_NOTFOUND	O arquivo 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 ter suporte a sistema de arquivos no SDCARD.
Para remover um arquivo, ele não pode possuir nenhum acesso de leitura e/ou escrita ativo.
Para remover um diretório, ele deve estar vazio (sem arquivos ou subdiretórios).
NAME deve iniciar com / e ter no máximo 64 caracteres.

Observações

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_CREATE_FILE, FS_CREATE_DIR, FS_RENAME_FILE_DIR, FS_EXIST_FILE_DIR, FS_CLEAR_DIR

Exemplo

Clique aqui para baixar a tabela de variáveis

Código ST

VAR
    FILE_NAME       : STRING := '/Dados.dat'; (* Constante string com o nome do arquivo a ser eliminado, no diretorio raiz *)
    MY_START        : BOOL := FALSE;          (* Ativacao da funcao *)
    STR_X           : STRING;                 (* Nome do arquivo ou diretorio a ser eliminado, limitado a 64 caracteres *)
    DELETE_FILE_DIR : HILS.FS_DELETE_FILE_DIR;(* Instancia do bloco "FS_DELETE_FILE_DIR" *)
END_VAR

//======================================================
// Exemplo 1 : Elimina arquivo no diretorio raiz
//======================================================
//
// Elimina o arquivo '/Dados.dat', localizado no diretorio raiz do sistema

STR_X := FILE_NAME;  // string com o caminho completo com nome atual do arquivo a ser eliminado

(* ... *)

//======================================================
// Exemplo 2 : Elimina arquivo dentro de um diretorio
//======================================================
//
// Elimina o arquivo 'Receita.cfg', localizado no diretorio "P1"

STR_X := '/P1/Receita.cfg';  // string com o caminho completo com nome atual do arquivo a ser eliminado

(* ... *)

//======================================================
// Exemplo 3 : Elimina um diretorio no raiz
//======================================================
//
// Elimina o diretorio 'PASTA_1', localizado na raiz do sistema de arquivo.
// Considera que o diretorio a ser eliminado esta vazio.

STR_X := '/PASTA_1';  // string com o caminho completo com nome atual do diretorio a ser eliminado

(* ... *)

//======================================================
// Exemplo 4 : Elimina um diretorio dentro de outro diretorio
//======================================================
//
// Elimina o diretorio 'P3' dentro do diretorio '/P1/P2/P3'
// Considera que o diretorio a ser eliminado esta vazio.

STR_X := '/P1/P2/P3';  // string com o caminho completo com nome atual do diretorio a ser eliminado

(* ... *)

//============================================================================
// Trata funcao FS_DELETE_FILE_DIR
//============================================================================

// Preenche parametros para a chamada do bloco de funcao
MY_START := TRUE;        // Ativacao do bloco da funcao
(* ... *)

// Exemplo de ativacao do bloco de funcao FS_DELETE_FILE_DIR
DELETE_FILE_DIR(
  EN    := TRUE,           // [BOOL] Habilitacao do bloco de funcao
  START := MY_START,       // [BOOL] Ativacao da funcao
  NAME  := STR_X           // [STRING] Caminho completo com nome atual do arquivo/diretorio a ser eliminado
  );

// Aguarda termino da execucao da funcao do sistema de arquivos
if (DELETE_FILE_DIR.DONE) then

  MY_START := FALSE;     // reseta ativacao da funcao

  // Testa codigo de retorno da execucao da funcao
  if (DELETE_FILE_DIR.RESULT = HILS.SUCCESS) then
    // ... Funcao executada com sucesso
  else
    // ... Erro na execucao da funcao
  end_if;

end_if;

(* ... *)