GetArchivData
Funkia
Funkcia GetArchivData slúži na získanie údajov z archívnej databázy.
Deklarácia
APIRET GetArchivData(const char *name, double Begin, double End, unsigned int Step, unsigned short wait, ChainBrowseDataPtr dataPtr)Parametre
Parameter name určuje meno archívneho objektu, Begin začiatok žiadaného časového intervalu a End koniec žiadaného časového intervalu. Parameter Step určuje časový krok s akým chceme získať údaje z archívu, ak je tento rovný nule, budú údaje posielané pre časy skutočne uložené v archíve. Parameter wait [s] určuje maximálny čas čakania na data z archívu.
Návratový kód
Kód | Popis |
API_OK | Korektné získanie údajov z archívu v časovom limite. Parametrom dataPtr vrátené formou zoznamu žiadané údaje. Po použití údajov je potrebné vrátiť rozhraniu D2000 ObjApi alokovanú pamäť pre každý ukazovateľ volaním funkcie FreeData. |
API_TimeoutError | Ak neboli údaje z archívu do požadovaného času získané. |
API_ParamError | Je parameter dataPtr rovný null alebo oba časy Begin a End sú neplatné. |
Súvisiace stránky: