Page tree
Skip to end of metadata
Go to start of metadata

Funkcia
Funkcia ListOfObjects slúži na získanie zoznamu objektov podľa daného kritéria.
Deklarácia
APIRET ListOfObjects(ListObjRqPtr rqPtr, USHORT wait, ChainListObjDataPtr dataPtr)

Parametre
Parameter rqPtr definuje žiadosť o zoznam. Je možné žiadať zoznam objektov konkrétneho typu alebo všetkých objektov (položka Type parametra rqPtr musí byť rovná O_ALL_TYPES). Zoznam je možné obmedziť zadaním masky (napr. *DI). Položka Access určuje prístupové práva, v zozname nebudú objekty na ktoré má žiadateľ nižšie práva ako práva dané touto položkou. Položka rel určuje vzťah žiadaných objektov k objektu danému parametrom Id, ak tento nie je nulový. Vzťah môže byť napríklad potomkovia, referenčné objekty atď. Parameter wait [s] určuje maximálny čas čakania na zoznam objektov.
Návratový kód
Hodnota Popis
API_OK Korektné získanie zoznamu objektov v časovom limite. Parametrom dataPtr sú 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 Neboli požadované údaje získané v požadovanom čase.
API_ParamError Ak majú parametre rqPtr alebo dataPtr hodnotu null.


Súvisiace stránky:

Write a comment…