DTC_GET_INFO
Retorna as informações (timestamp, identificador, atributo, tamanho e número de elementos) associadas ao 1º dado inserido na cache de dados especificada. É uma função.
Biblioteca: HI_STD · Namespace: HILS · Tipo: função
Função
DTC_GET_INFO
+-------------+
INT ---|CACHE |--- INT
| |
| TS|--- DT
| |
| ID|--- INT
| |
| ATRIB|--- USINT
| |
| SIZE|--- UINT
| |
| ELEM|--- UINT
+-------------+
A função inspeciona o 1º bloco de dados salvo na cache (a fila mantida em memória)
e devolve, pelas saídas, as informações associadas a esse item. CACHE é a cache
de dados mantida como uma fila dos blocos inseridos; para mais informações consulte
Estrutura da cache (CACHE).
Nota
No caso de dados do tipo string, SIZE retorna 1 (tamanho de 1 caractere) e
ELEM retorna o comprimento da string.
Parâmetros
Nome |
Direção |
Tipo |
Dimensão |
Padrão |
Faixa / Unidade |
Descrição |
|---|---|---|---|---|---|---|
CACHE |
IN |
INT |
[*] |
— |
— |
Cache de blocos de dados utilizada. |
TS |
OUT |
DT |
— |
— |
— |
Timestamp do 1º bloco de dados salvo na cache. |
ID |
OUT |
INT |
— |
— |
— |
Identificador do 1º bloco de dados salvo na cache. |
ATRIB |
OUT |
USINT |
— |
— |
— |
Atributo associado ao 1º bloco de dados salvo na cache. |
SIZE |
OUT |
UINT |
— |
— |
— |
Tamanho do dado no 1º bloco de dados salvo na cache (1 no caso de string). |
ELEM |
OUT |
UINT |
— |
— |
— |
Número de elementos associados ao dado (no caso de vetores); no caso de string, o comprimento da string. |
Códigos de retorno
A função retorna um INT como código de retorno: 0 = sucesso; valor
diferente de 0 = falha. Lista completa dos códigos de retorno:
RET_CODE - Códigos de retorno do firmware G5.
Pré-condições
A cache de dados (Estrutura da cache (CACHE)) deve ter sido inicializada e conter ao menos um bloco de dados inserido.
Observações
As informações retornadas referem-se sempre ao 1º bloco de dados da fila (o mais antigo ainda presente na cache).
Para strings, interprete
SIZEcomo o tamanho do caractere eELEMcomo o comprimento da string.
Ver também
DTC_MAN, DTC_PUSH, DTC_REMOVE, DTC_GET_VALUE, DTC_GET_BLOCKS, DTC_HOW_MANY_BLOCKS