Command (Zoznam funkcií)

Command (Zoznam funkcií)


Funkcia

Funkcia Command slúži na zaslanie textového povelu určitému klient procesu systému D2000, alebo procesu D2000 Server. Zoznam textových príkazov sa v dôsledku vývoja systému zväčšuje. Ich aktuálny zoznam je možné získať prostredníctvom procesu D2000 Application Manager

Deklarácia

APIRET Command(const char *cmd, HOBJ procesId, const char *procesName, int bTransAct);

Parametre

Parameter cmd predstavuje textový príkaz ktorý bude zaslaný procesu. Parameter procesId je jednoznačný identifikátor procesu v systéme. Ak je 0, je použitý parameter procesName ktorý musí obsahovať meno klient procesu.
Ak je procesId=0 a procesName je NULL alebo prazdný reťazec, textový povel bude zaslaný procesu D2000 Server.
Parameter bTransAct určuje, či bude volanie funkcie Command vykonané synchrónne (bTransAct /= 0) alebo asynchrónne (bTransAct = 0). Pri asynchrónnom vykonávaní povelu je tento do systému zaslaný ako žiadosť a funkcia nečaká na jej dokončenie. Pri synchrónnom vykonávaní povelu funkcia čaká na jeho dokončenie. Toto umožňuje testovať jeho úspešné (alebo neúspešné) vykonanie. 

Návratový kód

Kód

Popis

API_OK

Korektné otvorenie objektu.

API_TimeoutError

Pri synchrónnom vykonávaní bol prekročený maximálny čas.

API_TR_Abort

Pri synchrónnom vykonávaní neúspešné vykonanie povelu. 

API_TR_Error

Pri synchrónnom vykonávaní neúspešné vykonanie povelu.

API_TR_Ignored

Pri synchrónnom vykonávaní neúspešné vykonanie povelu.

API_ParamError

Nekorektné parametre.


Súvisiace stránky:

ObjApi - Výkonné funkcie