GetObjectValue
Funkcia
Funkcia GetObjectValue slúži na získanie okamžitej hodnoty objektu.
Deklarácia
APIRET GetObjectValue(const char *name, HOBJ id, ObjectInfoPtr data)Parametre
Parametre meno a id jednoznačne určujú objekt. Povinný je len jeden z týchto dvoch parametrov. Ak sa použije name, potom id musí byť rovné nule. V štruktúre data je spolu s ostatnými informáciami vrátená aktuálna hodnota a stav žiadaného objektu. Ak je hodnota objektu typu Text, Pole alebo Štruktúra, musí byť alokovaná pamäť pre hodnotu vrátená volaním FreeData.
Návratový kód
Hodnota | Popis |
API_OK | Korektné získanie hodnoty objektu. |
API_ObjNotExist | Požadovaný objekt neexistuje. |
API_TimeoutError | Nepodarilo získať hodnotu do požadovaného času. |
API_ParamError | Parameter data hodnotu null. |
Súvisiace stránky: