FS_CLOSE_FILE

Fecha um ou mais acessos de leitura/escrita a arquivos no sistema de arquivos do SDCARD, identificando o alvo pelo descritor (FD), pelo nome (NAME) ou fechando de uma só vez todos os acessos abertos. É 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_CLOSE_FILE
                            +------------------+
                   BOOL ----|START         DONE|---- BOOL
                            |                  |
HILS.FS_CLOSE_FILE_MODE ----|MODE        RESULT|---- INT
                            |                  |
                 STRING ----|FD      ACS_CLOSED|---- INT
                            |                  |
                    INT ----|NAME ------------ |----
                            +------------------+

A execução é iniciada colocando START em TRUE; se START retornar a FALSE antes do término, o bloco é resetado. O modo de fechamento é definido em MODE (tipo HILS.FS_CLOSE_FILE_MODE):

• HILS.CLOSE_FILE_BY_FD — fecha um único acesso, identificado pelo descritor informado em FD. Não é necessário preencher NAME.

• HILS.CLOSE_FILE_BY_NAME — fecha todos os acessos (leitura e escrita) abertos para o arquivo informado em NAME. A quantidade de acessos fechados é retornada em ACS_CLOSED. Não é necessário preencher FD.

• HILS.CLOSE_FILE_ALL — fecha todos os acessos de todos os arquivos abertos no sistema de arquivos. Não é necessário preencher FD nem NAME; o total de acessos fechados é retornado em ACS_CLOSED.

Ao concluir, DONE gera um pulso de um ciclo de scan; nesse instante o resultado deve ser consultado em RESULT.

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ção do bloco. Retornar a FALSE antes do término reseta a execução.
MODE	IN	FS_CLOSE_FILE_MODE	CLOSE_FILE_BY_FD	—	Modo de fechamento: por descritor, por nome ou todos os acessos.
FD	IN	INT	0	—	Descritor do arquivo a fechar. Usado quando MODE = HILS.CLOSE_FILE_BY_FD.
NAME	IN_OUT	STRING	—	= 64 caracteres	Caminho completo do arquivo (inicia com /). Usado quando MODE = HILS.CLOSE_FILE_BY_NAME.
DONE	OUT	BOOL	FALSE	—	Pulso de um scan indicando o término da execução.
RESULT	OUT	INT	0	RET_CODE	Código de retorno da execução (ver Códigos de retorno).
ACS_CLOSED	OUT	INT	0	—	Quantidade de acessos fechados (modos CLOSE_FILE_BY_NAME e CLOSE_FILE_ALL).

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	Função executada com sucesso.
5	GL_INV_PAR	Parâmetro(s) inválido(s).
7	GL_UNA_CMD	Comando não disponível ou não implementado.
8	GL_INV_STT	Estado corrente inválido.
10	GL_CMD_TMO	Timeout na execução do comando.
11	GL_CMD_CAN	Comando cancelado.
16	GL_CMD_PEND	Tratamento do comando pendente.
24	RE_NOT_AVA	Sem suporte para o sistema de arquivos ou SDCARD não detectado.
25	RE_INV_LEN	Tamanho especificado no parâmetro NAME inválido.
33	RE_NOT_INIT	Recurso não inicializado.
167	FS_CORRUPT	Sistema de arquivos pode estar corrompido.
173	FS_INVALIDNAME	Texto especificado no parâmetro NAME inválido.
174	FS_NOTFOUND	O arquivo não foi encontrado.
175	FS_DUPLICATED	O arquivo/diretório já existe.
177	FS_INVALID_HANDLE	Handle de arquivo aberto inválido.

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

Pré-condições

• O controlador deve possuir suporte a sistema de arquivos no SDCARD e o cartão deve estar presente e inicializado.

• No modo CLOSE_FILE_BY_FD, o descritor FD deve corresponder a um acesso aberto por FS_OPEN_FILE.

• No modo CLOSE_FILE_BY_NAME, NAME deve conter o caminho completo do arquivo, iniciando por / e com no máximo 64 caracteres.

Observações

• No modo CLOSE_FILE_BY_FD é fechado apenas o acesso associado ao descritor; ACS_CLOSED não é utilizado.

• Um mesmo arquivo pode ter mais de um acesso aberto (p. ex. duas leituras e uma escrita); no modo CLOSE_FILE_BY_NAME todos são fechados de uma vez.

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_OPEN_FILE, FS_CREATE_FILE, FS_READ_DATA_FILE, FS_WRITE_DATA_FILE, FS_FLUSH_FILE

Exemplo

Clique aqui para baixar a tabela de variáveis

Código ST

VAR
    FILE_DADOS : STRING := '/DADOS.DAT';      (* 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 : HILS.FS_CLOSE_FILE_MODE;     (* Modo de fechamento do arquivo *)
    FILE_NAME  : STRING;                      (* Nome do arquivo a ser fechado, limitado a 64 caracteres *)
    CLOSE_FILE : HILS.FS_CLOSE_FILE;          (* Instancia do bloco "FS_CLOSE_FILE" *)
END_VAR

//============================================================================
// 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;

(* ... *)