FS_GET_CUR_DIR
Obtém o caminho completo do diretório corrente de trabalho no sistema de arquivos (SDCARD) do controlador. É um bloco de função (mantém estado entre scans; requer instância) e depende de suporte de hardware para sistema de arquivos.
Biblioteca: HI_STD · Namespace: HILS · Tipo: bloco de função
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 de função
FS_GET_CUR_DIR
+----------------+
BOOL ----|START DONE|---- BOOL
| |
| RESULT|---- INT
| |
| PATH_DIR|---- STRING
+----------------+
A execução inicia quando START é colocado em TRUE. Se START retornar a
FALSE antes do fim da operação, o bloco é resetado. Ao término, DONE gera um
pulso de um único scan; nesse instante RESULT traz o código de retorno e
PATH_DIR traz o caminho corrente. No diretório raiz, PATH_DIR retorna a
string '/'.
Parâmetros
Nome |
Direção |
Tipo |
Padrão |
Faixa / Unidade |
Descrição |
|---|---|---|---|---|---|
START |
IN |
BOOL |
FALSE |
— |
Ativação da função. Em TRUE inicia a execução; ao voltar a FALSE antes do fim, o bloco é resetado. |
DONE |
OUT |
BOOL |
FALSE |
— |
Pulso de um scan indicando o término da execução; após ele, consulte |
RESULT |
OUT |
INT |
0 |
RET_CODE |
Código de retorno da execução (ver Códigos de retorno). |
PATH_DIR |
OUT |
STRING |
— |
— |
Caminho completo do diretório corrente. No diretório raiz retorna |
Códigos de retorno
RESULT carrega um código de retorno. Use os identificadores com o namespace
HILS (ex.: HILS.SUCCESS). Códigos mais comuns deste bloco:
Código |
Identificador |
Significado |
|---|---|---|
0 |
SUCCESS |
Diretório corrente obtido com sucesso. |
5 |
GL_INV_PAR |
Parâmetro(s) inválido(s). |
167 |
FS_CORRUPT |
Sistema de arquivos corrompido. |
178 |
FS_INVALID_DIR |
Diretório inválido ou inexistente. |
Lista completa dos códigos de retorno: RET_CODE - Códigos de retorno do firmware G5.
Pré-condições
O controlador deve possuir suporte de hardware para sistema de arquivos no SDCARD.
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
Exemplo
Clique aqui para baixar a tabela de variáveis
Código ST
VAR
PATH : STRING; (* String com o caminho do diretório corrente *)
MY_START : BOOL := FALSE; (* Ativa função do sistema de arquivo *)
CUR_DIR : HILS.FS_GET_CUR_DIR; (* Instância do bloco "FS_GET_CUR_DIR" *)
END_VAR
(* Exemplo para obter o diretório atual *)
(* Preenche parâmetros para a chamada do bloco de função *)
MY_START := TRUE; (* Ativa função do sistema de arquivo *)
(* Ativação do bloco de função FS_GET_CUR_DIR *)
CUR_DIR(
START := MY_START (* [BOOL] Ativa função do sistema de arquivo *)
);
(* Aguarda término da execução da função do sistema de arquivos *)
IF (CUR_DIR.DONE) THEN
(* Testa código de retorno da execução da função *)
IF (CUR_DIR.RESULT = HILS.SUCCESS) THEN
(* Função executada com sucesso. Resultado em CUR_DIR.PATH_DIR *)
PATH := CUR_DIR.PATH_DIR; (* [STRING] Caminho do diretório corrente *)
ELSE
(* Erro na execução: código em CUR_DIR.RESULT *)
;
END_IF;
END_IF;