HiLog

Overview

Provides logging functions.

For example, you can use these functions to output logs of the specified log type, service domain, log tag, and log level.

Since:

1.1

Version:

1.0

Summary

Macros

Macro Name and Value	Description
LOG_DOMAIN 0	Defines the service domain for a log file.
LOG_TAG NULL	Defines a string constant used to identify the class, file, or service behavior.
HILOG_DEBUG(type, ...) ((void)HiLogPrint(LOG_CORE, LOG_DEBUG, LOG_DOMAIN, LOG_TAG, __VA_ARGS__))	Outputs debug logs. This is a function-like macro.
HILOG_INFO(type, ...) ((void)HiLogPrint(LOG_CORE, LOG_INFO, LOG_DOMAIN, LOG_TAG, __VA_ARGS__))	Outputs informational logs. This is a function-like macro.
HILOG_WARN(type, ...) ((void)HiLogPrint(LOG_CORE, LOG_WARN, LOG_DOMAIN, LOG_TAG, __VA_ARGS__))	Outputs warning logs. This is a function-like macro.
HILOG_ERROR(type, ...) ((void)HiLogPrint(LOG_CORE, LOG_ERROR, LOG_DOMAIN, LOG_TAG, __VA_ARGS__))	Outputs error logs. This is a function-like macro.
HILOG_FATAL(type, ...) ((void)HiLogPrint(LOG_CORE, LOG_FATAL, LOG_DOMAIN, LOG_TAG, __VA_ARGS__))	Outputs fatal logs. This is a function-like macro.

Enumerations

Enumeration Name	Description
HiLogModuleType { HILOG_MODULE_HIVIEW = 0, HILOG_MODULE_SAMGR, HILOG_MODULE_ACE, HILOG_MODULE_APP, HILOG_MODULE_MAX }	Enumerates logging module types.
LogType	Enumerates log types.
LogLevel { LOG_DEBUG = 3, LOG_INFO = 4, LOG_WARN = 5, LOG_ERROR = 6, LOG_FATAL = 7 }	Enumerates log levels.

Functions

Function Name	Description
HiLogPrint (LogType type, LogLevel level, unsigned int domain, const char tag, const char fmt,...) __attribute__((format(os_log	int Outputs logs.

Function Name

Description

HiLogPrint (LogType type, LogLevel level, unsigned int domain, const char *tag, const char *fmt,...) __attribute__((format(os_log

int

Outputs logs.

Details

Macro Definition Documentation

HILOG_DEBUG

#define HILOG_DEBUG( type,  ... )   ((void)[HiLogPrint](HiLog.md#ga4c59c13fccc59c5821b23865fbc6380f)(LOG_CORE, [LOG_DEBUG](HiLog.md#ggaca1fd1d8935433e6ba2e3918214e07f9ab9f002c6ffbfd511da8090213227454e), [LOG_DOMAIN](HiLog.md#ga95a1d08c807e0aada863b5298a61d08d), [LOG_TAG](HiLog.md#ga7ce0df38eb467e59f209470c8f5ac4e6), __VA_ARGS__))

Description:

Outputs debug logs. This is a function-like macro.

Before calling this function, define the log service domain and log tag. Generally, you need to define them at the beginning of the source file.

Parameters:

Name	Description
type	Indicates the log type. The type for third-party applications is defined by LOG_APP.
fmt	Indicates the format string, which is an enhancement of a printf format string and supports the privacy identifier. Specifically, {public} or {private} is added between the % character and the format specifier in each parameter.
...	Indicates a list of parameters. The number and type of parameters must map onto the format specifiers in the format string.

Returns:

Returns 0 or a larger value if the operation is successful; returns a value smaller than 0 otherwise.

See also:

HiLogPrint

HILOG_ERROR

#define HILOG_ERROR( type,  ... )   ((void)[HiLogPrint](HiLog.md#ga4c59c13fccc59c5821b23865fbc6380f)(LOG_CORE, [LOG_ERROR](HiLog.md#ggaca1fd1d8935433e6ba2e3918214e07f9a230506cce5c68c3bac5a821c42ed3473), [LOG_DOMAIN](HiLog.md#ga95a1d08c807e0aada863b5298a61d08d), [LOG_TAG](HiLog.md#ga7ce0df38eb467e59f209470c8f5ac4e6), __VA_ARGS__))

Description:

Outputs error logs. This is a function-like macro.

Before calling this function, define the log service domain and log tag. Generally, you need to define them at the beginning of the source file.

Parameters:

Name	Description
type	Indicates the log type. The type for third-party applications is defined by LOG_APP.
fmt	Indicates the format string, which is an enhancement of a printf format string and supports the privacy identifier. Specifically, {public} or {private} is added between the % character and the format specifier in each parameter.
...	Indicates a list of parameters. The number and type of parameters must map onto the format specifiers in the format string.

Returns:

Returns 0 or a larger value if the operation is successful; returns a value smaller than 0 otherwise.

See also:

HiLogPrint

HILOG_FATAL

#define HILOG_FATAL( type,  ... )   ((void)[HiLogPrint](HiLog.md#ga4c59c13fccc59c5821b23865fbc6380f)(LOG_CORE, [LOG_FATAL](HiLog.md#ggaca1fd1d8935433e6ba2e3918214e07f9ac630750884d91cb9767ef2200bbb048b), [LOG_DOMAIN](HiLog.md#ga95a1d08c807e0aada863b5298a61d08d), [LOG_TAG](HiLog.md#ga7ce0df38eb467e59f209470c8f5ac4e6), __VA_ARGS__))

Description:

Outputs fatal logs. This is a function-like macro.

Before calling this function, define the log service domain and log tag. Generally, you need to define them at the beginning of the source file.

Parameters:

Name	Description
type	Indicates the log type. The type for third-party applications is defined by LOG_APP.
fmt	Indicates the format string, which is an enhancement of a printf format string and supports the privacy identifier. Specifically, {public} or {private} is added between the % character and the format specifier in each parameter.
...	Indicates a list of parameters. The number and type of parameters must map onto the format specifiers in the format string.

Returns:

Returns 0 or a larger value if the operation is successful; returns a value smaller than 0 otherwise.

See also:

HiLogPrint

HILOG_INFO

#define HILOG_INFO( type,  ... )   ((void)[HiLogPrint](HiLog.md#ga4c59c13fccc59c5821b23865fbc6380f)(LOG_CORE, [LOG_INFO](HiLog.md#ggaca1fd1d8935433e6ba2e3918214e07f9a6e98ff471e3ce6c4ef2d75c37ee51837), [LOG_DOMAIN](HiLog.md#ga95a1d08c807e0aada863b5298a61d08d), [LOG_TAG](HiLog.md#ga7ce0df38eb467e59f209470c8f5ac4e6), __VA_ARGS__))

Description:

Outputs informational logs. This is a function-like macro.

Before calling this function, define the log service domain and log tag. Generally, you need to define them at the beginning of the source file.

Parameters:

Name	Description
type	Indicates the log type. The type for third-party applications is defined by LOG_APP.
fmt	Indicates the format string, which is an enhancement of a printf format string and supports the privacy identifier. Specifically, {public} or {private} is added between the % character and the format specifier in each parameter.
...	Indicates a list of parameters. The number and type of parameters must map onto the format specifiers in the format string.

Returns:

Returns 0 or a larger value if the operation is successful; returns a value smaller than 0 otherwise.

See also:

HiLogPrint

HILOG_WARN

#define HILOG_WARN( type,  ... )   ((void)[HiLogPrint](HiLog.md#ga4c59c13fccc59c5821b23865fbc6380f)(LOG_CORE, [LOG_WARN](HiLog.md#ggaca1fd1d8935433e6ba2e3918214e07f9ac8041ffa22bc823d4726701cdb13fc13), [LOG_DOMAIN](HiLog.md#ga95a1d08c807e0aada863b5298a61d08d), [LOG_TAG](HiLog.md#ga7ce0df38eb467e59f209470c8f5ac4e6), __VA_ARGS__))

Description:

Outputs warning logs. This is a function-like macro.

Before calling this function, define the log service domain and log tag. Generally, you need to define them at the beginning of the source file.

Parameters:

Name	Description
type	Indicates the log type. The type for third-party applications is defined by LOG_APP.
fmt	Indicates the format string, which is an enhancement of a printf format string and supports the privacy identifier. Specifically, {public} or {private} is added between the % character and the format specifier in each parameter.
...	Indicates a list of parameters. The number and type of parameters must map onto the format specifiers in the format string.

Returns:

Returns 0 or a larger value if the operation is successful; returns a value smaller than 0 otherwise.

See also:

HiLogPrint

LOG_DOMAIN

#define LOG_DOMAIN   0

Description:

Defines the service domain for a log file.

The service domain is used to identify the subsystem and module of a service. Its value is a hexadecimal integer ranging from 0x0 to 0xFFFFF. If the value is beyond the range, its significant bits are automatically truncated. The recommended format is 0xAAABB, where AAA indicates the subsystem and BB indicates the module.

LOG_TAG

#define LOG_TAG   [NULL](UTILS.md#ga070d2ce7b6bb7e5c05602aa8c308d0c4)

Description:

Defines a string constant used to identify the class, file, or service behavior.

Enumeration Type Documentation

HiLogModuleType

enum [HiLogModuleType](HiLog.md#ga125ab0014dcc2b2152e0be2e39e31b9e)

Description:

Enumerates logging module types.

The module type must be globally unique. A maximum of 64 module types can be defined.

Enumerator	Description
HILOG_MODULE_HIVIEW	DFX
HILOG_MODULE_SAMGR	System Ability Manager
HILOG_MODULE_ACE	Update
HILOG_MODULE_APP	Third-party applications
HILOG_MODULE_MAX	Maximum number of modules

LogLevel

enum [LogLevel](HiLog.md#gaca1fd1d8935433e6ba2e3918214e07f9)

Description:

Enumerates log levels.

You are advised to select log levels based on their respective usage scenarios:

Enumerator	Description
LOG_DEBUG	Debug level to be used by HILOG_DEBUG
LOG_INFO	Informational level to be used by HILOG_INFO
LOG_WARN	Warning level to be used by HILOG_WARN
LOG_ERROR	Error level to be used by HILOG_ERROR
LOG_FATAL	Fatal level to be used by HILOG_FATAL

LogType

enum [LogType](HiLog.md#gaf67907baa897e9fb84df0cb89795b87c)

Description:

Enumerates log types.

Currently, LOG_APP is available.

Function Documentation

HiLogPrint()

int HiLogPrint ([LogType](HiLog.md#gaf67907baa897e9fb84df0cb89795b87c) type, [LogLevel](HiLog.md#gaca1fd1d8935433e6ba2e3918214e07f9) level, unsigned int domain, const char * tag, const char * fmt,  ... )

Description:

Outputs logs.

You can use this function to output logs based on the specified log type, log level, service domain, log tag, and variable parameters determined by the format specifier and privacy identifier in the printf format.

Parameters:

Name	Description
type	Indicates the log type. The type for third-party applications is defined by LOG_APP.
level	Indicates the log level, which can be LOG_DEBUG, LOG_INFO, LOG_WARN, LOG_ERROR, and LOG_FATAL.
domain	Indicates the service domain of logs. Its value is a hexadecimal integer ranging from 0x0 to 0xFFFFF. The recommended format is 0xAAABB, where AAA indicates the subsystem and BB indicates the module.
tag	Indicates the log tag, which is a string used to identify the class, file, or service behavior.
fmt	Indicates the format string, which is an enhancement of a printf format string and supports the privacy identifier. Specifically, {public} or {private} is added between the % character and the format specifier in each parameter.
...	Indicates a list of parameters. The number and type of parameters must map onto the format specifiers in the format string.

Returns:

Returns 0 or a larger value if the operation is successful; returns a value smaller than 0 otherwise.

Cain / docs

HiLog

Overview

Summary

Macros

Enumerations

Functions

Details

Macro Definition Documentation

HILOG_DEBUG

HILOG_ERROR

HILOG_FATAL

HILOG_INFO

HILOG_WARN

LOG_DOMAIN

LOG_TAG

Enumeration Type Documentation

HiLogModuleType

LogLevel

LogType

Function Documentation

HiLogPrint()

简介

发行版

贡献者

近期动态

Cain / docs .gitee-modal { width: 500px !important; }

HiLog

Overview

Summary

Macros

Enumerations

Functions

Details

Macro Definition Documentation

HILOG_DEBUG

HILOG_ERROR

HILOG_FATAL

HILOG_INFO

HILOG_WARN

LOG_DOMAIN

LOG_TAG

Enumeration Type Documentation

HiLogModuleType

LogLevel

LogType

Function Documentation

HiLogPrint()

简介

发行版

贡献者

近期动态

搜索帮助

Cain / docs