FS_DIR_INFO

Obtém informações de um diretório no sistema de arquivos do SDCARD do controlador (total de arquivos e atributos), retornando o resultado por pulso de conclusão. Exige controlador com suporte a sistema de arquivos no SDCARD. É 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_DIR_INFO
           +-----------------+
  BOOL ----|START        DONE|---- BOOL
           |                 |
           |           RESULT|---- INT
           |                 |
           |        TOT_FILES|---- INT
           |                 |
           |              ATR|---- WORD
           |                 |
STRING ----|NAME ----------- |----
           +-----------------+

A execução inicia quando START vai a TRUE. Se START retornar a FALSE antes do término da operação, o bloco é resetado. NAME deve conter o caminho completo do diretório, sempre iniciando por '/' (o diretório raiz é representado apenas por '/'). Ao final, DONE emite um pulso de um único scan; nesse instante RESULT indica o resultado da operação e, em caso de sucesso, TOT_FILES traz o número total de arquivos e ATR os atributos do diretório.

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 (TRUE) a execução; FALSE antes do término reseta o bloco.
NAME	IN_OUT	STRING	—	= 64 caracteres	Caminho completo do diretório a consultar, iniciando por `'/'` (raiz = `'/'`).
DONE	OUT	BOOL	FALSE	—	Pulso de um scan que sinaliza o fim da execução.
RESULT	OUT	INT	0	RET_CODE	Código de retorno da execução (ver Códigos de retorno).
TOT_FILES	OUT	INT	0	—	Número total de arquivos presentes no diretório.
ATR	OUT	WORD	0	—	Atributos do diretório (bits — ver Observações).

Códigos de retorno

RESULT é do tipo RET_CODE. Use os identificadores com o namespace HILS (ex.: HILS.FS_INVALID_DIR). 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.
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.
178	FS_INVALID_DIR	Diretório inválido ou inexistente (não encontrado, ou foi especificado um arquivo).

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 e o SDCARD detectado.
NAME deve iniciar por '/' e ter no máximo 64 caracteres.

Observações

DONE fica ativo por apenas um ciclo de scan; leia RESULT, TOT_FILES e ATR nesse instante.
Os atributos retornados em ATR são mapeados em bits, conforme a tabela abaixo.

Atributos no sistema de arquivos G5

Os atributos são mapeados em bits onde o significado de cada bit é descrito na tabela a seguir.

BIT	Descrição do Atributo
0	Arquivo oculto.
1	Arquivo com acesso apenas de leitura.
3	Arquivo de sistema. Gerenciado pelo HIstudio.
5	Arquivo de projeto do HIstudio.
7	Arquivo de dados gerênciado pela aplicação do PLC.
10	Atributo de diretório.

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_LIST_DIR, FS_FILE_INFO, FS_CREATE_DIR, FS_EXIST_FILE_DIR, FS_GET_INFO

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 na raiz *)
    MY_START  : BOOL := FALSE;      (* Ativação da função *)
    DIR_NAME  : STRING;             (* Caminho completo com o nome do diretório a obter informações *)
    DIR_INFO  : HILS.FS_DIR_INFO;   (* Instancia do bloco "FS_DIR_INFO" *)
END_VAR

//==========================================================
// Exemplo de parametrização 1: Informações de um diretório na raiz
//==========================================================

// Preenche parâmetros para a chamada do bloco de função
DIR_NAME := DIR_DADOS;   // Nome do diretório '/DADOS' na raiz

(* ... *)

//==========================================================
// Exemplo de parametrização 2: Informações de um diretório dentro de outro diretório
//==========================================================

// Preenche parâmetros para a chamada do bloco de função
DIR_NAME := '/PASTA_1/PASTA_2';    // String para informações do diretório "PASTA_2"

(* ... *)


//============================================================================
// Trata função FS_DIR_INFO
//============================================================================

// 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_DIR_INFO
DIR_INFO(
  START := MY_START,    // [BOOL] Ativação da função
  NAME  := DIR_NAME     // [STRING] Caminho completo com o nome do diretório a obter informações
  );

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

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

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

end_if;

(* ... *)