The interface containing the description of one message from a unit.
| Property | Parameter | Return Value | Description |
|---|---|---|---|
| Time | – | unsigned* Time | To get message time. The time is indicated in UNIX format, that is in seconds beginning from the 1st of January 1970. |
| TimeU | – | int* Time | The analogue of the property Time compatible with applications which do not support 64-bit integer numbers. Not available in 64-bit version. |
| Speed | – | int* Speed | To retrieve speed from a message. It is required to check the result of function operation because there can be no speed in a message. |
| Course | – | int* Course | To get movement direction from a message. It is required to check the result of function operation because there can be no course in a message. |
| X | – | double* X | To get longitude. It is required to check the result of function operation because there can be no location information in a message. |
| Y | – | double* Y | To get latitude. It is required to check the result of function operation because there can be no location information in a message. |
| Z | – | double* Z | To get altitude. It is required to check the result of function operation because there can be no location information in a message. |
| Type | – | BSTR* Type | To get message type: SMS, Data, CMD, etc. – udp – message contains location and data such as speed, course, number of satellites, I/O, driver ID. – ud – message contains only data from a device such as I/O and driver ID. – ucr – message contains information about an executed command (command name, parameters, user, link type, connector name, execution time). – us – message contains information about a received SMS message (SMS text, phone number). – evt – message contains location of an event happened. |
| CountSats | – | int* CountSats | To get the number of satellites which is important to estimate coordinates accuracy. If the number is 255, it means satellites are locked successfully but their number is unknown. It can happen if the device used does not send such information in general. It is required to check the result of function operation because there can be no location information in a message. |
| Param | int Number | IWialonParam **Param | To get messages parameter by its number. It is required to check each return value to be in existence (Not Nothing) or check return result (Error). |
| Location | – | BSTR* Location | To get unit location in the from of address. |
| ParamCount | – | long* ParamCount | To get the number of parameters in a message. |
| ParamByName | BSTR ParamName | IWialonParam **Param | To get a parameter by its name. It is required to check each return value to be in existence (Not Nothing) or check return result (Error). |
| SMSText | – | BSTR* SMS | To get SMS text (only for SMS messages). |
| Driver | – | BSTR* Driver | To get driver's name if known. |
| CMDName | – | BSTR* CMDName | To get command name if known. |
| CMDParam | – | BSTR* CMDParam | To get command parameters if known. |
| UserGUID | – | BSTR* UserGUID | To get the name the user who executed the command (if known). |
| LinkName | – | BSTR* LinkName | To get the name of hardware which were used to connect to the unit for command execution (if known). |
| LinkType | – | BSTR* LinkType | To get link type (UDP, TCP, GSM) used to execute a command (if known). |
| ModemPhone | – | BSTR* ModemPhone | To get the number of the modem used to execute a command (if known). |
| EventText | – | BSTR* EventText | To get event text if there is such. |
|
