FS_EXIST_FILE_DIR

Verifica se um arquivo ou diretório existe no sistema de arquivos do SDCARD, retornando o resultado na saída EXIST; requer que o controlador tenha suporte a sistema de arquivos. É 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_EXIST_FILE_DIR
           +--------------+
  BOOL ----|START     DONE|---- BOOL
           |              |
           |        RESULT|---- INT
           |              |
           |         EXIST|---- BOOL
           |              |
STRING ----|NAME -------- |----
           +--------------+

A execução é disparada colocando START em TRUE. Ao término, DONE gera um pulso de um ciclo de scan; nesse instante RESULT indica o resultado da operação e, em caso de sucesso (RESULT = HILS.SUCCESS), EXIST informa se o arquivo/diretório existe (TRUE) ou não (FALSE). Se START voltar a FALSE antes do término, o bloco é resetado.

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.

Parâmetros

Nome	Direção	Tipo	Padrão	Faixa / Unidade	Descrição
START	IN	BOOL	FALSE	—	Ativação da função. Colocar em TRUE para iniciar; voltar a FALSE antes do fim reseta o bloco.
NAME	IN_OUT	STRING	—	= 64 caracteres	Caminho completo (path) com o nome do arquivo/diretório a verificar. Deve iniciar com `/` (raiz).
DONE	OUT	BOOL	FALSE	—	Pulso de fim de execução (ativo por um ciclo de scan). Após o pulso, consultar `RESULT`.
RESULT	OUT	INT	0	RET_CODE	Código de retorno da execução (ver Códigos de retorno).
EXIST	OUT	BOOL	FALSE	—	Status de existência: TRUE = existe; FALSE = não existe. Válido apenas quando `RESULT` = `HILS.SUCCESS`.

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 (consultar `EXIST`).
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 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 no SDCARD (consultar o manual do controlador).
NAME deve iniciar com / e ter no máximo 64 caracteres.

Observações

EXIST só tem significado quando RESULT = HILS.SUCCESS.
DONE fica ativo por apenas um ciclo de scan; leia RESULT e EXIST nesse instante.

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_FILE_INFO, FS_DIR_INFO, FS_DELETE_FILE_DIR, FS_CREATE_FILE

Exemplo

Clique aqui para baixar a tabela de variáveis

Código ST

VAR
    FILE_DADOS     : STRING := '/DADOS.DAT'; (* Constante string com o nome do arquivo a ser verificado a existência *)
    MY_START       : BOOL := FALSE;          (* Ativação da função *)
    FILE_NAME      : STRING;                 (* Nome do arquivo a ser verificado a existência, limitado a 64 caracteres *)
    EXIST_FILE_DIR : HILS.FS_EXIST_FILE_DIR; (* Instancia do bloco "FS_EXIST_FILE_DIR" *)
END_VAR

//======================================================
// Exemplo 1 : Checa se existe arquivo no diretório raiz
//======================================================
//
// Checa existência do arquivo '/DADOS.DAT', localizado no diretório raiz do sistema

FILE_NAME := FILE_DADOS; // string com o caminho completo para o arquivo '/DADOS.DAT' na raiz

(* ... *)

//======================================================
// Exemplo 2 : Checa se existe arquivo dentro de um diretório
//======================================================
//
// Checa existência do arquivo 'Receita.cfg', localizado no diretório "P1"

FILE_NAME := '/P1/Receita.cfg';  // string com o caminho completo do arquivo

(* ... *)

//======================================================
// Exemplo 3 : Checa se existe um diretório no raiz
//======================================================
//
// Checa existência do diretório 'PASTA_1', localizado na raiz do sistema de arquivo.

FILE_NAME := '/PASTA_1';  // string com o caminho completo com nome do diretório

(* ... *)

//======================================================
// Exemplo 4 : Checa se existe um diretório dentro de outro diretório
//======================================================
//
// Checa existência do diretório 'P3' dentro do diretório '/P1/P2'

FILE_NAME := '/P1/P2/P3';  // string com o caminho completo com nome do diretório

(* ... *)

//============================================================================
// Trata função FS_EXIST_FILE_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_EXIST_FILE_DIR
EXIST_FILE_DIR(
  START := MY_START,  // [BOOL] Ativação da função
  NAME  := FILE_NAME  // [STRING] Path com o nome do arquivo a ser verificado se existe
  );

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

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

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

end_if;

(* ... *)