Funkcia %HI_OpenRow

Funkcia

Funkcia sprístupní hodnoty v riadku objektu typu Štruktúrovaná premenná.

Deklarácia

INT %HI_OpenRow(
   HBJ in refToStruct,
   INT in index
   [BOOL in bAsync := @FALSE]
 )

Parametre

refToStruct	Odkaz na objekt typu Štruktúrovaná premenná.
index	Riadok štruktúrovanej premennej.
bAsync	@TRUE - asynchrónna funkcia. @FALSE - synchrónna funkcia.

Popis

Funkcia sprístupní hodnoty určitého riadku štruktúrovanej premennej, ktorý je daný parametrom index. Štruktúrovaná premenná je daná parametrom refToStruct (napríklad: SV.Struktura\HBJ). Hodnota parametra index nie je kontrolovaná vzhľadom na rozmer štruktúrovanej premennej.

Funkcia je podľa hodnoty parametra bAsync:

Asynchrónna (bAsync = @TRUE)
Volanie funkcie má charakter žiadosti o aktualizáciu hodnôt daného riadku. Preto čas od ktorého budú hodnoty v žiadanom riadku aktualizované závisí od celkového zaťaženia systému. Návratová hodnota funkcie je 0.
Synchrónna (bez parametra bAsync, alebo bAsync = @FALSE)
Po ukončení volania funkcie je zaručená platnosť (aktuálnosť) hodnôt v žiadanom riadku. Návratová hodnota funkcie je _ERR_NO_ERROR pri jej úspešnom vykonaní.

Poznámka

Pre zmysluplné použitie funkcie musí byť zapnuté filtrovanie hodnôt štruktúrovanej premennej vytvorením lokálnej premennej typu Record pre danú štruktúrovanú premennú so zapnutým filtrovaním.

Príklad

Sprístupnenie hodnôt na riadku 5 štruktúrovanej premennej SV.Struktura:

 INT  _retCode
 TEXT _errMsg
 
 _retCode := %HI_OpenRow(SV.Struktura\HBJ, 5)
 IF _retCode # _ERR_NO_ERROR THEN
   _errMsg := "%HI_OpenRow(SV.Struktura\HBJ ErrorCode = " + %IToStr(_retCode)
 
 ELSE ; hodnoty sú prístupné
 
 ENDIF

Súvisiace stránky: