FS_CREATE_DIR

Criar um diretório no sistema de arquivos do SDCARD.

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_CREATE_DIR
           +--------------+
  BOOL ----|START     DONE|---- BOOL
           |              |
           |        RESULT|---- INT
           |              |
STRING ----|NAME -------- |----
           +--------------+

Parâmetros

Nome

Classe

Tipo

Dim.

V. Ini.

Descrição

START

Entrada

BOOL

FALSE

Ativação da função

NAME

Entrada/Saída

STRING

Caminho completo com o nome do diretório a ser criado

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

Considerações para utilização da função:

  • A função permite criar múltiplos diretórios. Exemplo: Passando o parâmetro NAME como “/PASTA_1/PASTA_2”, se os diretórios intermediários não existem, os mesmos são criados. Ou sej, se o diretório “PASTA_1” não existe, o mesmo é criado, e assim sucessivamente para os demais diretórios intermediários especificados no parãmetro.

Detalhamento dos Parâmetros

Parâmetro

Descrição

START

Deve ser colocado em “TRUE” para iniciar a execução. Caso seu valor seja alterado para “FALSE” antes do fim da operação, o bloco irá ser resetado.

NAME

Este parâmetro deve ser especificado com o caminho completo para o nome diretório a ser criado. O diretório raiz é identificado pelo caractere ‘/’, e desta forma este parâmetro deve sempre iniciar com este caractere.

Exemplo de diretório: ‘/DADOS’, ‘/RECEITAS/AZUL’, ‘/PASTA_1/PASTA_2/PASTA_3’

O tamanho máximo permitido para o caminho do nome do diretório é de 64 caracteres.

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”.

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 [3]

Segue alguns exemplos de códigos de retorno:

RESULT

LABEL [4]

Descrição

0

HILS.SUCCESS

Função executada com sucesso.

5

HILS.GL_INV_PAR

Parâmetro(s) inválido(s).

7

HILS.GL_UNA_CMD

Comando não disponivel ou nao implementado.

8

HILS.GL_INV_STT

Estado corrente inválido.

11

HILS.GL_CMD_CAN

Comando cancelado.

16

HILS.GL_CMD_PEND

Tratamento do comando pendente.

24

HILS.RE_NOT_AVA

Sem suporte para o sistema de arquivos ou SDCARD não detectado.

25

HILS.RE_INV_LEN

Tamanho especificado no parâmetro “NAME” inválido.

33

HILS.RE_NOT_INIT

Recurso não inicializado.

167

HILS.RC_FS_CORRUPT

Sistema de arquivo pode estar corrompido.

173

HILS.RC_FS_INVALIDNAME

Texto especificado no parâmetro “NAME” inválido.

175

HILS.RC_FS_DUPLICATED

O arquivo ou diretório já existe.

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

Opções

Descrição

DIR_DADOS

STRING

‘/DADOS’

Const

Constante string com o nome do diretório a ser criado na raiz

MY_START

BOOL

FALSE

Ativação da função

STR_X

STRING

Nome do diretório a ser criado, até 64 caracteres

CREATE_DIR

FS_CREATE_DIR

Instancia do bloco “FS_CREATE_DIR”

Clique aqui para baixar a tabela de variáveis

Código ST

//============================================================================
// Exemplo 1 : Cria diretorio no raiz do sistema de arquivo
//============================================================================

// Preenche parâmetros para a chamada do bloco de função
STR_X    := DIR_DADOS;   // Nome do diretorio '/DADOS' no raiz do sistema de arquivo
MY_START := TRUE;        // Ativação do bloco da função

(* ... *)

//============================================================================
// Exemplo 2 : Cria diretorio dentro de outro diretório
//============================================================================
// Cria o diretório "ESTILO_A" dentro do diretório "/Receitas".

// Preenche parâmetros para a chamada do bloco de função
STR_X    := '/Receitas/ESTILO_A';   // Caminho completo com o nome dos diretórios a serem criados
MY_START := TRUE;                   // Ativação do bloco da função

(* ... *)

//============================================================================
// Exemplo 3 : Cria diretorio dentro de outro diretório
//============================================================================
// Cria o diretório "P4" dentro do diretório "/P1/P2/P3".

// Preenche parâmetros para a chamada do bloco de função
STR_X    := '/P1/P2/P3/P4';   // Caminho completo com o nome dos diretórios a serem criados
MY_START := TRUE;             // Ativação do bloco da função

(* ... *)

//============================================================================
// Trata função FS_CREATE_DIR
//============================================================================

// Exemplo de ativação do bloco de função FS_CREATE_DIR
CREATE_DIR(
  START := MY_START,       // [BOOL] Ativação da função
  NAME  := STR_X           // [STRING] Nome do diretório a ser criado
  );

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

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

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

end_if;

(* ... *)