GetTimeReply
Reply message in response to the GetTime message. It contains the standard fields that describe the response to a message. By examining the values of the message fields it is possible to determine the outcome of the message.
- Section: Transactions
- Related Message: GetTime
ResultCode - The result of the message. In general, 0 means success and a number other than zero means failure.
ErrorParam - If ResultCode is nonzero, the ErrorParam may be set in order to determine which field the error relates to. If set, it is the KVP number of the field which caused the error. For example, if the ResultCode is
ERROR_PERMISSION_DENIED, the ErrorParam allows the caller to determine which entity in the transaction they do not have permission for.
Metadata
- Message Type: ReplyMessage
- Message Number: 10502
Inherited fields
| Name | Type | Size (bytes) | Description |
|---|---|---|---|
| MessageType | Integer (unsigned) | 2 | The unique identifier of this message. |
| ClientId | Integer (unsigned) | 4 | The unique identifier of a session with the server, returned in a successful LoginReply message. |
| RequestId | Integer (unsigned) | 4 | Within each session each message must be uniquely identified by this field. It must be monotonically increasing for the duration of the session. |
| ResultCode | Integer (signed) | 4 | The result of the message. In general, 0 means success and a number other than zero means failure. |
| ErrorParam | Integer (unsigned) | 2 | If ResultCode is nonzero, the ErrorParam may be set in order to determine which field the error relates to. If set, it is the KVP number of the field which caused the error. For example, if the ResultCode is ERROR_PERMISSION_DENIED, the ErrorParam allows the caller to determine which entity in the transaction they do not have permission for. |
Fields
| Name | Type | Size (bytes) | Description |
|---|---|---|---|
| Date | Integer (signed) | 4 | Represents a date as an integer in YYYYMMDD format. |
| Time | Integer (signed) | 4 | Represents time as an integer in HHMMSS format. |
| Seconds | Integer (unsigned) | 4 | The running engine SystemTime value. This is the number of seconds since the epoch, but this time will not tick during any given transaction. It also uses the time logged with a given transaction when replaying a transaction log. |