HIWG_FSPUBLISH
Transfere para uma cache de dados uma variável ou vetor de variáveis da aplicação, para que sejam publicados/persistidos por meio do gerenciador HIWG_FSMAN; deve ser usada apenas após a inicialização do bloco gerenciador estar concluída. É uma função.
Biblioteca: HI_STD · Namespace: HILS · Tipo: função
Função
HIWG_FSPUBLISH
+--------------+
INT ---|ID |--- INT
| |
USINT ---|ATRIB |
| |
BOOL ---|GEN_TS |
| |
DT ---|TS |
| |
ANY ---|DATA |
| |
HILS.HIWG_FSMAN ---|FSMAN ------- |---
+--------------+
Esta função deve ser utilizada apenas após a inicialização do bloco gerenciador HIWG_FSMAN estar concluída. Ela transfere para a cache de dados uma variável ou vetor da aplicação, permitindo manter uma cache associada a um arquivo para preservar os dados caso a cache em RAM não possua espaço.
Parâmetros
Nome |
Direção |
Tipo |
Padrão |
Faixa / Unidade |
Descrição |
|---|---|---|---|---|---|
ID |
IN |
INT |
— |
— |
Identificador associado ao bloco de dados salvo na cache. |
ATRIB |
IN |
USINT |
— |
0 .. 7 |
Atributo associado ao dado; o significado é definido pela aplicação que o consome. |
GEN_TS |
IN |
BOOL |
— |
— |
Se TRUE, gera automaticamente o timestamp do dado (ignora |
TS |
IN |
DT |
— |
— |
Timestamp a associar ao bloco de dados quando |
DATA |
IN |
ANY |
— |
— |
Dado ou vetor de dados nativo a ser salvo na cache de blocos de dados. |
FSMAN |
IN_OUT |
|
— |
— |
Gerenciador associado à cache do portal de telemetria. |
Códigos de retorno
A função retorna um código INT do tipo RET_CODE: 0 ( HILS.SUCCESS ) em caso de
sucesso ou um dos códigos de falha abaixo.
Código |
Identificador |
Significado |
|---|---|---|
0 |
SUCCESS |
Dado inserido na cache com sucesso. |
5 |
GL_INV_PAR |
Parâmetro inválido: tipo de dado não suportado (ex.: estrutura, WSTRING) ou quantidade de elementos do vetor inválida. |
28 |
RE_FIL_OVF |
Espaço insuficiente na cache para salvar o dado especificado. |
Lista completa: RET_CODE - Códigos de retorno do firmware G5.
Pré-condições
A inicialização do bloco gerenciador HIWG_FSMAN deve estar concluída antes de utilizar esta função.
DATAdeve ser de um tipo nativo suportado — não são aceitos estruturas,WSTRINGnem vetores de strings.
Observações
Esta função é um wrapper para DTC_PUSH; consulte aquela página para os detalhes de comportamento e dos parâmetros.
Com
GEN_TS= TRUE, o valor deTSé ignorado.