FS_CLOSE_FILE

Fechar um acesso de leitura ou escrita a um arquivo de dados no sistema de arquivos do SDCARD.

Pode-se fechar o acesso ao arquivo especificando o seu descritor FD ou o seu respectivo nome.

Opcionalmente podemos fechar todos os acessos de leitura e escrita de todos os arquivos.

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_CLOSE_FILE
                            +------------------+
                   BOOL ----|START         DONE|---- BOOL
                            |                  |
HILS.FS_CLOSE_FILE_MODE ----|MODE        RESULT|---- INT
                            |                  |
                 STRING ----|FD      ACS_CLOSED|---- INT
                            |                  |
                    INT ----|NAME ------------ |----
                            +------------------+

Parâmetros

Nome	Classe	Tipo	Dim.	V. Ini.	Descrição
START	Entrada	BOOL		FALSE	Ativação da função
MODE	Entrada	HILS.FS_CLOSE_FILE_MODE		0	Modo de fechamento do arquivo
NAME	Entrada/Saída	STRING			Caminho completo para o nome do arquivo a ser fechado
FD	Entrada	INT		0	Descritor do arquivo a ser fechado
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
ACS_CLOSED	Saída	INT		0	Quantidade de acessos fechados associados ao arquivo

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.
MODE	O modo de fechamento do arquivo deve ser do tipo “CLOSE_FILE_MODE” com as seguites opções: HILS.CLOSE_FILE_BY_FD: Fecha o arquivo considerando o descritor do arquivo especificado no parametro de entrada “FD”. Neste caso não é necessário especificar o parâmetro de entrada “NAME”. Note que neste modo é fechado apenas um único acesso de leitura ou escrita na qual foi aberto este arquivo, especificado na função FS_OPEN_FILE. HILS.CLOSE_FILE_BY_NAME: Fecha o arquivo considerando o nome do arquivo especificado no parametro de entrada “NAME”. Neste caso não é necessário especificar o parâmetro de entrada “FD”. Note que neste modo são fechados todos os acessos de leitura e escrita que estejam abertos para este arquivo. A quantidade de acessos fechados para o arquivo especificado é retornado no parâmetro ACS_CLOSED. HILS.CLOSE_FILE_ALL: Fecha o acesso a todos os arquivos do sistema de arquivos. Neste caso não é necessário especificar os parâmetros de entrada “FD” e “NAME”. Note que neste modo são fechados todos os acessos de leitura e escrita de todos os arquivos que estejam abertos no sistema de arquivos. A quantidade de acessos fechados é retornado no parâmetro ACS_CLOSED.
FD	Descritor do arquivo a ser fechado. Parâmetro necessário quando MODE = HILS.CLOSE_FILE_BY_FD.
NAME	Este parâmetro deve ser especificado com o caminho completo para o nome do arquivo a ser fechado. Parâmetro necessário quando MODE = HILS.CLOSE_FILE_BY_NAME. O diretório raiz é identificado pelo caractere ‘/’, e desta forma este parâmetro deve sempre iniciar com este caractere. Exemplo de arquivo: ‘/Dados.dat’, ‘/Pasta_1/Dados.dat’, ‘/PASTA_1/PASTA_2/Receita.cfg’ O tamanho máximo permitido para o caminho do nome do arquivo é 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]
ACS_CLOSED	No modo HILS.CLOSE_FILE_BY_FD esse parâmetro não é utilizado. No modo HILS.CLOSE_FILE_BY_NAME retorna a quantidade de acessos fechados associados ao arquivo. Note que um mesmo arquivo pode possuir mais de um acesso, por exemplo, dois acesso de leitura e outro de escrita, e neste caso todos os acessos são fechados, retornando valor 3. No modo HILS.CLOSE_FILE_ALL retorna a quantidade de acessos (leitura e escrita) fechados considerando todos os arquivos que possuem algum acesso aberto no sistema de arquivo.

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.
10	HILS.GL_CMD_TMO	Timeout na execução do comando.
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.
174	HILS.RC_FS_NOTFOUND	O arquivo não foi encontrado.
175	HILS.RC_FS_DUPLICATED	O arquivo já existe.
177	HILS.RC_FS_INVALID_HANDLE	Handle de arquivo aberto inválido

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 a ser fechado na raiz
MY_START	BOOL	FALSE		Ativação da função
FILE_FD	INT			Descritor do arquivo a ser fechado
CLOSE_MODE	FS_CLOSE_FILE_MODE			Modo de fechamento do arquivo
FILE_NAME	STRING			Nome do arquivo a ser fechado, limitado a 64 caracteres
CLOSE_FILE	FS_CLOSE_FILE			Instancia do bloco “FS_CLOSE_FILE”

Clique aqui para baixar a tabela de variáveis

Código ST

//============================================================================
// Exemplo de parametrização 1: Fechamento no modo CLOSE_FILE_BY_FD
//============================================================================

// Preenche parâmetros para a chamada do bloco de função
FILE_FD    := 0;                     // Descritor do arquivo a ser fechado
CLOSE_MODE := HILS.CLOSE_FILE_BY_FD; // Modo de fechamento do arquivo

(* ... *)

//============================================================================
// Trata função FS_CLOSE_FILE no modo CLOSE_FILE_BY_FD
//============================================================================

// Preenche 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_CLOSE_FILE
CLOSE_FILE(
  START := MY_START,         // [BOOL] Ativação da função
  MODE  := CLOSE_MODE,       // [INT] Modo de fechamento do arquivo
  FD    := FILE_FD           // [INT] Descritor do arquivo
  );

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

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

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

end_if;

(* ... *)


//============================================================================
// Exemplo de parametrização 2: Fechamento no modo CLOSE_FILE_BY_NAME arquivo na raiz
//============================================================================

// Preenche parâmetros para a chamada do bloco de função
FILE_NAME  := FILE_DADOS;              // Nome do arquivo '/DADOS.DAT' na raiz
CLOSE_MODE := HILS.CLOSE_FILE_BY_NAME; // Modo de fechamento do arquivo

(* ... *)

//============================================================================
// Exemplo de parametrização 3: Fechamento no modo CLOSE_FILE_BY_NAME arquivo dentro de diretório
//============================================================================

// Preenche parâmetros para a chamada do bloco de função
FILE_NAME  := '/Pasta_1/Dados.dat';    // Nome do arquivo 'Dados.Dat' dentro do diretório "/Pasta_1"
CLOSE_MODE := HILS.CLOSE_FILE_BY_NAME; // Modo de fechamento do arquivo

(* ... *)

//============================================================================
// Trata função FS_CLOSE_FILE no modo CLOSE_FILE_BY_NAME
//============================================================================

// Preenche 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_CLOSE_FILE
CLOSE_FILE(
  START := MY_START,         // [BOOL] Ativação da função
  MODE  := CLOSE_MODE,       // [INT]  Modo de fechamento do arquivo
  NAME  := FILE_NAME         // [STRING] Caminho completo para o nome do arquivo a ser fechado
  );

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

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

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

end_if;

(* ... *)


//============================================================================
// Exemplo de parametrização 4: Fechamento no modo CLOSE_FILE_ALL
//============================================================================

// Preenche parâmetros para a chamada do bloco de função
CLOSE_MODE := HILS.CLOSE_FILE_ALL;     // Modo de fechamento do arquivo

(* ... *)

//============================================================================
// Trata função FS_CLOSE_FILE no modo CLOSE_FILE_ALL
//============================================================================

// Preenche 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_CLOSE_FILE
CLOSE_FILE(
  START := MY_START,         // [BOOL] Ativação da função
  MODE  := CLOSE_MODE        // [INT] Modo de fechamento do arquivo
  );

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

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

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

end_if;

(* ... *)