FS_FILE_INFO

Obtém informações (atributos e acessos abertos) de um arquivo existente no sistema de arquivos do SDCARD do controlador. Exige suporte a sistema de arquivos no equipamento e é 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_FILE_INFO
           +-----------------+
  BOOL ----|START        DONE|---- BOOL
           |                 |
           |           RESULT|---- INT
           |                 |
           |              ATR|---- WORD
           |                 |
           |        RD_ACCESS|---- INT
           |                 |
           |        WR_ACCESS|---- INT
           |                 |
STRING ----|NAME ----------- |----
           +-----------------+

A execução é iniciada colocando START em TRUE. Se START retornar a FALSE antes do fim da operação, o bloco é resetado. O término é sinalizado por um pulso de um scan em DONE; nesse instante o resultado deve ser consultado em RESULT e, em caso de sucesso, os atributos e contagens de acesso ficam disponíveis em ATR, RD_ACCESS e WR_ACCESS.

O parâmetro NAME deve conter o caminho completo do arquivo. O diretório raiz é identificado por / e o caminho deve sempre iniciar com esse caractere (ex.: /Dados.dat, /Pasta_1/Dados.dat, /PASTA_1/PASTA_2/Receita.cfg). O tamanho máximo do caminho é de 64 caracteres.

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 a execução do bloco; retornar a FALSE antes do fim reseta o bloco.
NAME	IN_OUT	STRING	—	até 64 caracteres	Caminho completo do arquivo a consultar; deve iniciar com /.
DONE	OUT	BOOL	FALSE	—	Pulso de um scan indicando o término da execução.
RESULT	OUT	INT	0	RET_CODE	Código de retorno da execução (ver Códigos de retorno).
ATR	OUT	WORD	0	bitmap	Atributos do arquivo existente (mapeados em bits; ver Observações).
RD_ACCESS	OUT	INT	0	—	Número total de acessos atualmente abertos para leitura.
WR_ACCESS	OUT	INT	0	—	Número total de acessos atualmente abertos para escrita.

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 arquivos pode estar corrompido.
174	FS_NOTFOUND	O arquivo não foi encontrado ou foi especificado um diretório.

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.

• O SDCARD deve estar presente e inicializado.

• NAME deve iniciar com / e ter no máximo 64 caracteres.

Observações

• DONE fica ativo por apenas um ciclo de scan; consulte RESULT nesse instante.

• Os atributos em ATR são mapeados em bits: bit 0 = arquivo oculto; bit 1 = somente leitura; bit 3 = arquivo de sistema (gerenciado pelo HIstudio); bit 5 = arquivo de projeto do HIstudio; bit 7 = arquivo de dados gerenciado pela aplicação do PLC; bit 10 = atributo de diretório.

Ver também

FS_DIR_INFO, FS_EXIST_FILE_DIR, FS_OPEN_FILE, FS_GET_INFO

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 obter informações no raiz *)
    MY_START   : BOOL := FALSE;          (* Ativação da função *)
    FILE_NAME  : STRING;                 (* Nome do arquivo a ser obtido as informações, limitado a 64 caracteres *)
    FILE_INFO  : HILS.FS_FILE_INFO;      (* Instancia do bloco "FS_FILE_INFO" *)
END_VAR

//==========================================================
// Exemplo de parametrização 1: Obter informações de arquivo no diretório raiz
//==========================================================

// Preenche parâmetros para a chamada do bloco de função
FILE_NAME := FILE_DADOS;  // Nome do arquivo '/DADOS.DAT' no raiz do sistema de arquivo

(* ... *)

//==========================================================
// Exemplo de parametrização 2: Obter informações de arquivo dentro de um diretório
//==========================================================
// Informações do arquivo "Setup.cfg" dentro da pasta "/P1"

// Preenche parâmetros para a chamada do bloco de função
FILE_NAME  := '/P1/Setup.cfg';   // Caminho completo com o nome do arquivo a obter informações

(* ... *)

//==========================================================
// Exemplo de parametrização 3: Obter informações de arquivo dentro de diretórios
//==========================================================
// Informações do arquivo "Log.txt" dentro das pastas "/Info/LOG"

// Preenche parâmetros para a chamada do bloco de função
FILE_NAME  := '/Info/LOG/Log.txt';   // Caminho completo com o nome do arquivo a obter informações

(* ... *)

//============================================================================
// Trata função FS_FILE_INFO
//============================================================================

// Preenche 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_FILE_INFO
FILE_INFO(
  START := MY_START,     // [BOOL] Ativação da função
  NAME  := FILE_NAME     // [STRING] Caminho completo com o nome do arquivo a obter informações
  );

// Aguarda término da execução da função do sistema de arquivos
IF (FILE_INFO.DONE) THEN

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

  // Testa código de retorno da execução da função
  IF (FILE_INFO.RESULT = HILS.SUCCESS) THEN
    // ... Função executada com sucesso

    // Informações do arquivo disponíveis em :
    //
    // FILE_INFO.ATR        Atributos do arquivo existente
    // FILE_INFO.RD_ACCESS  Número total de acessos atualmente abertos para leitura
    // FILE_INFO.WR_ACCESS  Número total de acessos atualmente abertos para escrita

  ELSE
    // ... Erro na execução da função
  END_IF;

END_IF;

(* ... *)