FS_LIST_DIR

Listar todos os arquivos e pastas de um diretório. A cada execução retorna um arquivo ou pasta 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.

Bloco

              FS_LIST_DIR
           +----------------+
           |            DONE|---- BOOL
           |                |
           |          RESULT|---- INT
           |                |
           |            NAME|---- STRING
           |                |
           |             ATR|---- WORD
           |                |
           |            DATE|---- DT
           |                |
  BOOL ----|RESTART --------|----
           |                |
  BOOL ----|GET ----------- |----
           |                |
STRING ----|DIR ----------- |----
           +----------------+

Parâmetros

Nome	Classe	Tipo	Dim.	V. Ini.	Descrição
RESTART	Entrada/Saída	BOOL		FALSE	Abre diretório e posiciona leitor no primeiro item (Arquivo/Pasta)
GET	Entrada/Saída	BOOL		FALSE	Lê item (Arquivo/Pasta) do diretório que foi aberto e incrementa a posição do leitor
DIR	Entrada/Saída	STRING			Caminho completo com o nome do diretório desejado para listar
DONE	Saída	BOOL		FALSE	Pulso de fim de execução da função
RESULT	Saída	INT		0	Código de retorno da execução da função
NAME	Saída	STRING			Nome do arquivo ou pasta retornado
ATR	Saída	WORD		0	Atributos do arquivo ou pasta
DATE	Saída	DT			Data e hora do arquivo ou pasta

Detalhamento dos Parâmetros

Parâmetro	Descrição
RESTART	Abre diretório especificado em “DIR” e posiciona leitor no primeiro item (Arquivo/Pasta). Ao final da execução, seu valor é zerado. OBS: O comando de RESTART pode ser enviado em cojunto com o GET, posicionando o leitor e lendo o primeiro item do diretório em sequência.
GET	Lê item do diretório (Arquivo/Pasta) que foi aberto e incrementa a posição do leitor. Ao final da execução, seu valor é zerado.
DIR	Nome do diretório a ser acessado. Utilizado apenas no comando RESTART. Para acessar o diretório atual “DIR” deverá ser uma string nula ‘’. Para acessar diretamente o diretório raiz “DIR” deverá ser uma string com ‘/’.
DONE	Pulso para indicar o término da execução da função. Após este pulso (fica ativo por apenas um ciclo de scan), o resultado da execução da função deve ser consultado no parâmetro de saída “RESULT”.
NAME	Retorna nome do arquivo ou pasta corrente no diretório pesquisado. Se o diretório corrente for o raiz do sistema de arquivo, o seguinte caminho é retornado: ‘/’ : Diretório raiz do sistema de arquivo Se a pasta corrente é um sub-diretório, os seguintes itens são retornados: ‘.’ : Identificação para o diretório corrente ‘..’ : Identificação para o diretório pai
ATR	Atributos do arquivo ou pasta
DATE	Data e hora de alteração do arquivo ou pasta. A data e hora dos arquivos e pastas estão associados ao relógio calendário do controlador, com fuso horário de referência UTC (“Coordinated Universal Time” ou Tempo Universal Coordenado) O Tempo Universal Coordenado, também conhecido como tempo civil, é o fuso horário de referência a partir do qual se calculam todas as outras zonas horárias do mundo. O horário oficial do Brasil (horário de Brasília), também denominado horário local, está -3:00 horas do horário UTC.
RESULT	Código de retorno associado a execução da função, onde: Se for igual a 0: Função executada com sucesso, código HILS.SUCCESS Se for diferente de 0: Falha na execução da função [2]

OBS: Caso GET tenha atingido o fim do diretório, será retornado o código de erro RC_FS_NOTFOUND = 174.

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”

Exemplo

Declaração de variáveis

Nome	Tipo	Valor Inicial	Descrição
DIR_SEC	STRING	‘/DIR2’	String com o nome do diretório a ser acessado na raiz
DIR_ROOT	STRING	‘/’	String para acesso ao diretório raiz
MY_RESTART	BOOL	FALSE	Abre diretório e posiciona leitor no primeiro item (Arquivo/Pasta)
MY_GET	BOOL	FALSE	Lê item (Arquivo/Pasta) do diretório que foi aberto e incrementa a posição do leitor
MY_DIR	STRING		Nome do diretório a ser lido
LIST_DIR	FS_LIST_DIR		Instância do bloco “FS_LIST_DIR”

Clique aqui para baixar a tabela de variáveis

Código ST

//==============================================================
// Exemplo para a leitura do diretório '/DIR2'
// que está dentro do diretório atual
//==============================================================

// Preenche parâmetros para a chamada do bloco de função
MY_DIR := DIR_SEC;        // Nome para acessar o diretório 'DIR2'
MY_RESTART := TRUE;       // Abre diretório e posiciona leitor no primeiro item (Arquivo/Pasta)
MY_GET := TRUE;           // Lê item (Arquivo/Pasta) do diretório que foi aberto e incrementa a posição do leitor

(* ... *)

// Exemplo de ativação do bloco de função FS_LIST_DIR
LIST_DIR(
  RESTART := MY_RESTART,       // [BOOL] Abre diretório e posiciona leitor no primeiro item (Arquivo/Pasta)
  GET := MY_GET,               // [BOOL] Lê item (Arquivo/Pasta) do diretório que foi aberto e incrementa a posição do leitor
  DIR := MY_DIR                // [STRING] Nome do diretório
  );

// Aguarda término da execução da função do sistema de arquivos
if (LIST_DIR.DONE) then
  // Testa código de retorno da execução da função
  if (LIST_DIR.RESULT = HILS.SUCCESS) then
    // ... Função executada com sucesso.
    //     Resultado da leitura do primeiro arquivo ou pasta disponível em:
    //     LIST_DIR.NAME          // [STRING] Nome do arquivo ou pasta retornado
    //     LIST_DIR.ATR           // [WORD] Atributos do arquivo ou pasta
    //     LIST_DIR.DATE          // [DT] Data e hora de criação do arquivo ou pasta
    //
    // ... Para continuar a leitura deste diretório utilizar
    //     RESTART := FALSE;
    //     GET := TRUE;
  else
    // ... Erro na execução da função
    //     ou fim do diretório (LIST_DIR.RESULT = RC_FS_NOTFOUND)
  end_if;

end_if;

(* ... *)

//==============================================================
// Exemplo para a leitura do diretório raiz
//==============================================================

// Para ler os arquivos e pastas do diretório raiz especificar
// uma string com '/' na variável "DIR".

// Preenche parâmetros para a chamada do bloco de função
MY_DIR := DIR_ROOT;         // Nome para acessar o diretório raiz
MY_RESTART := TRUE;         // Abre diretório e posiciona leitor no primeiro item (Arquivo/Pasta)
MY_GET := TRUE;             // Lê item (Arquivo/Pasta) do diretório que foi aberto e incrementa a posição do leitor

(* ... *)

// Exemplo de ativação do bloco de função FS_LIST_DIR
LIST_DIR(
  RESTART := MY_RESTART,         // [BOOL] Abre diretório e posiciona leitor no primeiro item (Arquivo/Pasta)
  GET := MY_GET,                 // [BOOL] Lê item (Arquivo/Pasta) do diretório que foi aberto e incrementa a posição do leitor
  DIR := MY_DIR                  // [STRING] Nome do diretório
  );

// Aguarda término da execução da função do sistema de arquivos
if (LIST_DIR.DONE) then
  // Testa código de retorno da execução da função
  if (LIST_DIR.RESULT = HILS.SUCCESS) then
    // ... Função executada com sucesso
    //     Resultado da leitura do primeiro arquivo ou pasta disponível em:
    //     LIST_DIR.NAME          // [STRING] Nome do arquivo ou pasta retornado
    //     LIST_DIR.ATR           // [WORD] Atributos do arquivo ou pasta
    //     LIST_DIR.DATE          // [DT] Data e hora de criação do arquivo ou pasta
    //
    // ... Para continuar a leitura deste diretório utilizar
    //     RESTART := FALSE;
    //     GET := TRUE;
  else
    // ... Erro na execução da função
    //     ou fim do diretório (LIST_DIR.RESULT = RC_FS_NOTFOUND)
  end_if;

end_if;

(* ... *)