FS_COPY_FILE

Copia um arquivo (apenas arquivos, não diretórios) no sistema de arquivos do SDCARD, sobrescrevendo o arquivo de destino caso ele já exista. É 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_COPY_FILE
           +-----------------+
  BOOL ----|START        DONE|---- BOOL
           |                 |
           |           RESULT|---- INT
           |                 |
STRING ----|CUR_NAME --------|----
           |                 |
STRING ----|NEW_NAME --------|----
           +-----------------+

A cópia é iniciada colocando START em TRUE; se START voltar a FALSE antes do término da operação, o bloco é resetado. Ao concluir, DONE emite um pulso de um único ciclo de scan e o resultado deve ser consultado em RESULT. O processo cria um novo arquivo em NEW_NAME; se já existir um arquivo com esse nome, ele será sobrescrito.

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 do bloco; em FALSE antes do fim reseta o bloco.
CUR_NAME	IN_OUT	STRING	—	= 64 caracteres	Caminho completo do arquivo de origem a ser copiado (deve iniciar com `/`).
NEW_NAME	IN_OUT	STRING	—	= 64 caracteres	Caminho completo do arquivo de destino (deve iniciar com `/`).
DONE	OUT	BOOL	FALSE	—	Pulso (um scan) que indica o fim da execução; leia `RESULT` neste instante.
RESULT	OUT	INT	0	RET_CODE	Código de retorno da execução (ver Códigos de retorno).

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	Arquivo copiado com sucesso.
5	GL_INV_PAR	Parâmetro(s) inválido(s).
10	GL_CMD_TMO	Timeout na execução do comando.
24	RE_NOT_AVA	Sem suporte a sistema de arquivos ou SDCARD não detectado.
167	FS_CORRUPT	Sistema de arquivos pode estar corrompido.
173	FS_INVALIDNAME	Nome de arquivo inválido (`CUR_NAME` ou `NEW_NAME`).
174	FS_NOTFOUND	Arquivo de origem não encontrado.
178	FS_INVALID_DIR	Diretório inválido ou inexistente.

Lista completa: RET_CODE - Códigos de retorno do firmware G5.

Pré-condições

O controlador deve ter suporte a sistema de arquivos no SDCARD (ver nota acima).
CUR_NAME e NEW_NAME devem iniciar com / (caminho a partir da raiz) e ter no máximo 64 caracteres.
O arquivo de origem (CUR_NAME) deve existir.

Observações

Caso NEW_NAME já exista, o arquivo será sobrescrito.
Não é possível copiar diretórios, apenas arquivos.
DONE fica ativo por apenas um ciclo de scan; o código de retorno deve ser consultado em RESULT nesse instante.

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_RENAME_FILE_DIR, FS_DELETE_FILE_DIR, FS_CREATE_FILE, FS_EXIST_FILE_DIR

Exemplo

Clique aqui para baixar a tabela de variáveis

Código ST

VAR
    FILE_DADOS    : STRING := '/DADOS.DAT'; (* Nome do arquivo origem, no diretório raiz *)
    FILE_BACKUP   : STRING := '/DADOS.BAK'; (* Nome do arquivo destino, no diretório raiz *)
    MY_START      : BOOL := FALSE;          (* Ativação da função *)
    CUR_COPY_NAME : STRING;                 (* Nome do arquivo origem, limitado a 64 caracteres *)
    NEW_COPY_NAME : STRING;                 (* Nome do arquivo destino, limitado a 64 caracteres *)
    COPY_FILE     : HILS.FS_COPY_FILE;      (* Instancia do bloco "FS_COPY_FILE" *)
END_VAR

//======================================================
// Exemplo 1 : Copia arquivo no diretorio raiz
//======================================================
//
// Copia o arquivo '/DADOS.DAT', localizado no diretório raiz do sistema
// para o mesmo diretorio raiz '/DADOS.BAK'

CUR_COPY_NAME := FILE_DADOS;  // caminho para o nome do arquivo origem, no diretório raiz
NEW_COPY_NAME := FILE_BACKUP; // caminho para o nome do arquivo destino

(* ... *)

//======================================================
// Exemplo 2 : Copia arquivo dentro de diretórios
//======================================================
//
// Copia o arquivo 'DADOS.DAT', localizado no diretório "/P1/P2/P3"
// para o diretorio '/BACKUP/JAN'

CUR_COPY_NAME := '/P1/P2/P3/DADOS.DAT'; // caminho para o nome do arquivo origem
NEW_COPY_NAME := '/BACKUP/JAN/DADOS.BAK'; // caminho para o nome do arquivo destino

(* ... *)

//======================================================
// Trata função FS_COPY_FILE
//======================================================

// 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_COPY_FILE
COPY_FILE(
  START    := MY_START,        // [BOOL] Ativação da função
  CUR_NAME := CUR_COPY_NAME,   // [STRING] Caminho completo do arquivo origem
  NEW_NAME := NEW_COPY_NAME    // [STRING] Caminho completo do arquivo destino
  );

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

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

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

end_if;

(* ... *)