|
|
| boolean ConEvents::Retrieve |
( |
[out] array |
pEvents, |
|
|
[out] int |
nPeriod |
|
) |
| |
Retrieve.
Use this method to retrieve events.
- Parameters:
-
| pEvents | [out] (array) Events array. Each element of array is params with attributes:
| Attribute | Type | Description |
| KLSRV_CON_EVENT_TYPE | paramString | Event type |
| KLSRV_CON_EVENT_PARAMS | paramParams | Event params |
| KLSRV_CON_EVENT_BIRTH_TIME | paramDateTime | UTC time of creation |
| KLSRV_CON_EVENT_LIFE_TIME | paramInt | Event life time in seconds |
|
| nPeriod | [out] (int) new value of polling period, milliseconds |
- Returns:
- (boolean) true if more events exist, otherwise - false
- Exceptions:
-
| STDE_NOTFOUND | - subscription was not found |
| STDE_UNAVAIL | - period of polling is too small. Please use recommended period of polling. |
- See also:
- Event polling usage
|
