time_service.h

Overview

Declares the APIs for obtaining the time and time zone.

Library: libtime_service_ndk.so

File to include: <BasicServicesKit/time_service.h>

System capability: SystemCapability.MiscServices.Time

Since: 12

Related module: TimeService

Name	typedef Keyword	Description
TimeService_ErrCode	TimeService_ErrCode	Enumerates the error codes.

Name	Description
TimeService_ErrCode OH_TimeService_GetTimeZone(char *timeZone, uint32_t len)	Obtains the current system time zone.

enum TimeService_ErrCode

Description

Enumerates the error codes.

Since: 12

Enum Item	Description
TIMESERVICE_ERR_OK = 0	Operation successful.
TIMESERVICE_ERR_INTERNAL_ERROR = 13000001	Failed to obtain system parameters.
TIMESERVICE_ERR_INVALID_PARAMETER = 13000002	Invalid parameter.

TimeService_ErrCode OH_TimeService_GetTimeZone(char *timeZone, uint32_t len)

Description

Obtains the current system time zone.

System capability: SystemCapability.MiscServices.Time

Since: 12

Parameters

Name	Description
char *timeZone	Pointer to the string array of time zone IDs. If the timezone is obtained, its ID is written. Otherwise, an empty string is written. The string ends with \0.
uint32_t len	Length of a string array of time zone IDs without maximum limit. You are advised to apply for sufficient memory for at least 31 bytes.

Returns

Type	Description
TimeService_ErrCode	Returns TIMESERVICE_ERR_OK if the operation is successful; returns TIMESERVICE_ERR_INTERNAL_ERROR if the system parameters fail to be obtained; returns TIMESERVICE_ERR_INVALID_PARAMETER if timeZone is a null pointer or the length of the time zone name (excluding the end character \0) is greater than or equal to the value of len.