FS_RENAME_FILE_DIR

Renomear um arquivo ou 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_RENAME_FILE_DIR
           +------------------+
  BOOL ----|START         DONE|---- BOOL
           |                  |
           |            RESULT|---- INT
           |                  |
STRING ----|PATH_NAME --------|----
           |                  |
STRING ----|NEW_NAME -------- |----
           +------------------+

Parâmetros

Nome	Classe	Tipo	Dim.	V. Ini.	Descrição
START	Entrada	BOOL		FALSE	Ativação da função
PATH_NAME	Entrada/Saída	STRING			Caminho completo com nome atual do arquivo/diretório a ser renomeado
NEW_NAME	Entrada/Saída	STRING			Novo nome para o arquivo/diretório a ser renomeado, sem o caminho completo
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:

Para renomear um arquivo este não pode possuir nenhum acesso de leitura e/ou escrita ativo.

Um diretório para ser renomeado não precisa estar vazio.

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.
CUR_NAME	Este parâmetro deve ser especificado com o caminho completo para o nome do arquivo/diretório a ser renomeado. O diretório raiz é identificado pelo caractere ‘/’, e desta forma este parâmetro deve sempre iniciar com este caractere. Exemplo de arquivo origem: ‘/Dados.dat’, ‘/Pasta_1/Dados.dat’, ‘/PASTA_1/PASTA_2/Receita.cfg’ Exemplo de diretório origem: ‘/DADOS’, ‘/RECEITAS/AZUL’, ‘/PASTA_1/PASTA_2/PASTA_3’ O tamanho máximo permitido para o caminho do nome atual do arquivo ou diretório é de 64 caracteres.
NEW_NAME	Este parâmetro deve especificar apenas o novo nome do arquivo/diretório desejado. Considera-se o caminho completo especificado no parâmetro CUR_NAME acima. Exemplo de arquivo destino: ‘Dados.Bak’, ‘Receita1.Dat’, ‘LOG.TXT’ Exemplo de diretório destino: ‘PASTA_JAN’, ‘BACKUP’, ‘ANTIGO’ O tamanho máximo permitido para o novo nome do arquivo ou 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 disponível ou não implementado.
8	HILS.GL_INV_STT	Estado corrente inválido.
10	HILS.GL_CMD_TMO	Timeout na execução do comando.
11	HILS.GL_CMD_CAN	Comando cancelado.
13	HILS.GL_FUNC_FAIL	Falha na execução da função.
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 parâmetro ‘CUR_NAME’ ou ‘NEW_NAME’ inválido.
33	HILS.RE_NOT_INIT	Recurso não inicializado.
167	HILS.RC_FS_CORRUPT	Sistema de arquivo pode estar corrompido.
170	HILS.RC_FS_WRITE_LOCK	Arquivo já está aberto para escrita
173	HILS.RC_FS_INVALIDNAME	Texto especificado no parâmetro ‘CUR_NAME’ ou ‘NEW_NAME’ inválido.
		O parâmetro ‘CUR_NAME’ não foi especificado com caminho completo.
		O parâmetro ‘NEW_NAME’ foi especificado com caminho completo, e este deve ser especificado sem o caminho completo.
174	HILS.RC_FS_NOTFOUND	O arquivo não foi encontrado.
175	HILS.RC_FS_DUPLICATED	O arquivo 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
FILE_DADOS	STRING	‘/DADOS.DAT’	Const	Constante String com o nome do arquivo, no diretório raiz
FILE_BACKUP	STRING	‘DADOS.BAK’	Const	Constante String com o nome do arquivo
MY_START	BOOL	FALSE		Ativação da função
CUR_REN_NAME	STRING			Nome do arquivo corrente a ser renomeado, limitado a 64 caracteres
NEW_REN_NAME	STRING			Novo nome do arquivo a ser renomeado, limitado a 64 caracteres
RENAME_FILE	FS_RENAME_FILE_DIR			Instancia do bloco “FS_RENAME_FILE_DIR”

Clique aqui para baixar a tabela de variáveis

Código ST

//======================================================
// Exemplo 1 : Renomeia arquivo no diretorio raiz
//======================================================
//
// Renomeia o arquivo '/DADOS.DAT', localizado no diretório raiz do sistema
// para o nome 'DADOS.BAK', resultando em '/DADOS.BAK'

CUR_REN_NAME := FILE_DADOS;  // string com o caminho para o nome do arquivo origem, no diretório raiz
NEW_REN_NAME := FILE_BACKUP; // string com o nome do arquivo destino

(* ... *)

//======================================================
// Exemplo 2 : Renomeia arquivo dentro de diretórios
//======================================================
//
// Renomeia o arquivo 'DADOS.DAT', localizado no diretório "/P1/P2/P3"
// para o nome 'DADOS.BAK', resultando em '/P1/P2/P3/DADOS.BAK'

CUR_REN_NAME := '/P1/P2/P3/DADOS.DAT'; // string com o caminho para o nome do arquivo origem, no diretório raiz
NEW_REN_NAME := 'DADOS.BAK',           // string com o nome do arquivo destino

(* ... *)


//======================================================
// Exemplo 3 : Renomeia Diretório na raiz do sistema de arquivo
//======================================================
//
// Renomeia o diretorio '/PASTA_1', localizado no diretório raiz do sistema
// para o nome 'PASTA_2', resultando em "/PASTA_2"

CUR_REN_NAME := '/PASTA_1'; // string com o caminho para o nome do diretorio origem
NEW_REN_NAME := 'PASTA_2',  // string com o nome do diretorio destino

(* ... *)

//======================================================
// Exemplo 4 : Renomeia Diretório dentro de outros diretórios
//======================================================
//
// Renomeia o diretorio "JAN" localizado no diretorio '/DADOS/MES',
// para o nome 'FEV', resultando em "/DADOS/MES/FEV"

CUR_REN_NAME := '/DADOS/MES/JAN'; // string com caminho para o nome do diretorio origem
NEW_REN_NAME := 'FEV',            // string com o nome do diretorio destino

(* ... *)

//============================================================================
// Trata função FS_RENAME_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_RENAME_FILE_DIR
RENAME_FILE(
  START    := MY_START,        // [BOOL] Ativação da função
  CUR_NAME := CUR_REN_NAME,    // [STRING] Caminho completo com nome atual do arquivo/diretório a ser renomeado
  NEW_NAME := NEW_REN_NAME     // [STRING] Novo nome para o arquivo/diretório a ser renomeado, sem o caminho completo
  );

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

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

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

end_if;

(* ... *)