FS_FLUSH_FILE

Realizar o flush de dados de um arquivo de dados no sistema de arquivos do SDCARD. O flush salva as modificações realizadas em um arquivo no SDCARD, evitando a perda de informação em caso de reinicialização.

Exemplo de utilização: Se a aplicação abre um arquivo, e o mantêm aberto apenas escrevendo dados periodicamente, as informações alteradas são armazenadas em uma cache interna do sistema de arquivo, e quando esta cache é completada, as informações da cache são automaticamente transferidas e preservadas no arquivo. Se durante este processo de escrita, a aplicação desejar salvar os dados que estão na cache para o arquivo, basta utilizar esta função FS_FLUSH_FILE. Note que a função FS_CLOSE_FILE também realiza automaticamente esta função de “flush” da cache para o arquivo, antes de fechar o mesmo.

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_FLUSH_FILE
         +--------------+
BOOL ----|START     DONE|---- BOOL
         |              |
 INT ----|FD      RESULT|---- INT
         +--------------+

Parâmetros

Nome	Classe	Tipo	Dim.	V. Ini.	Descrição
START	Entrada	BOOL		FALSE	Ativação da função
FD	Entrada	INT		0	Descritor do arquivo a ser realizado flush de dados
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

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.
FD	Descritor do arquivo a ser realizado o flush de dados.
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.
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.
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 aberto para escrita
177	HILS.RC_FS_INVALID_HANDLE	Handle de arquivo aberto inválido.

Exemplo

Declaração de variáveis

Nome	Tipo	Valor Inicial	Descrição
MY_START	BOOL	FALSE	Ativação da função
FILE_FD	INT		Descritor do arquivo a ser realizado o flush de dados
FLUSH_FILE	FS_FLUSH_FILE		Instancia do bloco “FS_FLUSH_FILE”

Clique aqui para baixar a tabela de variáveis

Código ST

// Preenche parâmetros para a chamada do bloco de função
FILE_FD    := 0;                     // Descritor do arquivo
MY_START   := TRUE;                  // Ativação do bloco da função
(* ... *)

// Exemplo de ativação do bloco de função FS_FLUSH_FILE
FLUSH_FILE(
  START := MY_START,         // [BOOL] Ativação da função
  FD    := FILE_FD           // [INT] Descritor do arquivo
  );

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

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

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

end_if;

(* ... *)