1e41f4b71Sopenharmony_ci# TimeService 2e41f4b71Sopenharmony_ci 3e41f4b71Sopenharmony_ci 4e41f4b71Sopenharmony_ci## Overview 5e41f4b71Sopenharmony_ci 6e41f4b71Sopenharmony_ciEnables the application to obtain the time and time zone information. 7e41f4b71Sopenharmony_ci 8e41f4b71Sopenharmony_ci**Since**: 12 9e41f4b71Sopenharmony_ci 10e41f4b71Sopenharmony_ci 11e41f4b71Sopenharmony_ci## Summary 12e41f4b71Sopenharmony_ci 13e41f4b71Sopenharmony_ci 14e41f4b71Sopenharmony_ci### File 15e41f4b71Sopenharmony_ci 16e41f4b71Sopenharmony_ci| Name| Description| 17e41f4b71Sopenharmony_ci| -------- | -------- | 18e41f4b71Sopenharmony_ci| [time_service.h](time__service_8h.md) | Declares the API for obtaining the time and time zone information. | 19e41f4b71Sopenharmony_ci 20e41f4b71Sopenharmony_ci 21e41f4b71Sopenharmony_ci### Types 22e41f4b71Sopenharmony_ci 23e41f4b71Sopenharmony_ci| Name| Description| 24e41f4b71Sopenharmony_ci| -------- | -------- | 25e41f4b71Sopenharmony_ci| typedef enum [TimeService_ErrCode](#timeservice_errcode)[TimeService_ErrCode](#timeservice_errcode) | Enumerates the error codes.| 26e41f4b71Sopenharmony_ci 27e41f4b71Sopenharmony_ci 28e41f4b71Sopenharmony_ci### Enums 29e41f4b71Sopenharmony_ci 30e41f4b71Sopenharmony_ci| Name| Description| 31e41f4b71Sopenharmony_ci| -------- | -------- | 32e41f4b71Sopenharmony_ci| [TimeService_ErrCode](#timeservice_errcode) {<br>TIMESERVICE_ERR_OK = 0,<br>TIMESERVICE_ERR_INTERNAL_ERROR = 13000001,<br>TIMESERVICE_ERR_INVALID_PARAMETER = 13000002<br>} | Enumerates the error codes.| 33e41f4b71Sopenharmony_ci 34e41f4b71Sopenharmony_ci 35e41f4b71Sopenharmony_ci### Functions 36e41f4b71Sopenharmony_ci 37e41f4b71Sopenharmony_ci| Name| Description| 38e41f4b71Sopenharmony_ci| -------- | -------- | 39e41f4b71Sopenharmony_ci| [TimeService_ErrCode](#timeservice_errcode)[OH_TimeService_GetTimeZone](#oh_timeservice_gettimezone) (char \*timeZone, uint32_t len) | Returns the current system time zone. | 40e41f4b71Sopenharmony_ci 41e41f4b71Sopenharmony_ci 42e41f4b71Sopenharmony_ci## Type Description 43e41f4b71Sopenharmony_ci 44e41f4b71Sopenharmony_ci 45e41f4b71Sopenharmony_ci### TimeService_ErrCode 46e41f4b71Sopenharmony_ci 47e41f4b71Sopenharmony_ci``` 48e41f4b71Sopenharmony_citypedef enum TimeService_ErrCode TimeService_ErrCode 49e41f4b71Sopenharmony_ci``` 50e41f4b71Sopenharmony_ci 51e41f4b71Sopenharmony_ci**Description** 52e41f4b71Sopenharmony_ci 53e41f4b71Sopenharmony_ciEnumerates the error codes. 54e41f4b71Sopenharmony_ci 55e41f4b71Sopenharmony_ci**Since**: 12 56e41f4b71Sopenharmony_ci 57e41f4b71Sopenharmony_ci 58e41f4b71Sopenharmony_ci## Enum Description 59e41f4b71Sopenharmony_ci 60e41f4b71Sopenharmony_ci 61e41f4b71Sopenharmony_ci### TimeService_ErrCode 62e41f4b71Sopenharmony_ci 63e41f4b71Sopenharmony_ci``` 64e41f4b71Sopenharmony_cienum TimeService_ErrCode 65e41f4b71Sopenharmony_ci``` 66e41f4b71Sopenharmony_ci 67e41f4b71Sopenharmony_ci**Description** 68e41f4b71Sopenharmony_ci 69e41f4b71Sopenharmony_ciEnumerates the error codes. 70e41f4b71Sopenharmony_ci 71e41f4b71Sopenharmony_ci**Since**: 12 72e41f4b71Sopenharmony_ci 73e41f4b71Sopenharmony_ci| Value| Description| 74e41f4b71Sopenharmony_ci| -------- | -------- | 75e41f4b71Sopenharmony_ci| TIMESERVICE_ERR_OK | Obtains system parameters.| 76e41f4b71Sopenharmony_ci| TIMESERVICE_ERR_INTERNAL_ERROR | Fails to obtain system parameters.| 77e41f4b71Sopenharmony_ci| TIMESERVICE_ERR_INVALID_PARAMETER | Invalid parameter.| 78e41f4b71Sopenharmony_ci 79e41f4b71Sopenharmony_ci 80e41f4b71Sopenharmony_ci## Function Description 81e41f4b71Sopenharmony_ci 82e41f4b71Sopenharmony_ci 83e41f4b71Sopenharmony_ci### OH_TimeService_GetTimeZone() 84e41f4b71Sopenharmony_ci 85e41f4b71Sopenharmony_ci``` 86e41f4b71Sopenharmony_ciTimeService_ErrCode OH_TimeService_GetTimeZone (char * timeZone, uint32_t len ) 87e41f4b71Sopenharmony_ci``` 88e41f4b71Sopenharmony_ci 89e41f4b71Sopenharmony_ci**Description** 90e41f4b71Sopenharmony_ci 91e41f4b71Sopenharmony_ciReturns the current system time zone. 92e41f4b71Sopenharmony_ci 93e41f4b71Sopenharmony_ci**System capability**: SystemCapability.MiscServices.Time 94e41f4b71Sopenharmony_ci 95e41f4b71Sopenharmony_ci**Since**: 12 96e41f4b71Sopenharmony_ci 97e41f4b71Sopenharmony_ci**Parameters** 98e41f4b71Sopenharmony_ci 99e41f4b71Sopenharmony_ci| Name| Description| 100e41f4b71Sopenharmony_ci| -------- | -------- | 101e41f4b71Sopenharmony_ci| timeZone | A character array of time zone ID. If the time zone is obtained, the time zone ID string of the current system is written. Otherwise, an empty string is written. The string ends with **\0**. | 102e41f4b71Sopenharmony_ci| len | Length of a character array of time zone ID without maximum limit. You are advised to apply for sufficient memory for at less 31 bytes. | 103e41f4b71Sopenharmony_ci 104e41f4b71Sopenharmony_ci**Returns** 105e41f4b71Sopenharmony_ci 106e41f4b71Sopenharmony_ci**TIMESERVICE_ERR_OK**: The system parameters are obtained. 107e41f4b71Sopenharmony_ci 108e41f4b71Sopenharmony_ci**TIMESERVICE_ERR_INTERNAL_ERROR**: The system parameters fail to be obtained. 109e41f4b71Sopenharmony_ci 110e41f4b71Sopenharmony_ci**TIMESERVICE_ERR_INVALID_PARAMETER**: The time zone is null or the length of the time zone name (excluding the end character **\0**) is greater than or equal to **len**.