harmony 鸿蒙@ohos.process (Obtaining Process Information)

2025-06-12
浏览 (3)

@ohos.process (Obtaining Process Information)

The process module provides process management APIs, for example, APIs for obtaining process information.

NOTE

The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import { process } from '@kit.ArkTS';

Attributes

System capability: SystemCapability.Utils.Lang

Atomic service API: This API can be used in atomic services since API version 11.

Name	Type	Readable	Writable	Description
uid	number	Yes	No	User identifier (UID) of the process.
pid	number	Yes	No	Process ID (PID) of the process.
tid⁸⁺	number	Yes	No	Thread ID (TID) of the thread.

EventListener

type EventListener = (evt: Object) => void

Describes the event to store.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
evt	Object	Yes	Event.

process.isIsolatedProcess⁸⁺

isIsolatedProcess(): boolean

Checks whether this process is isolated.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
boolean	Check result. The value true means that the process is isolated, and false means the opposite.

Example

let result = process.isIsolatedProcess();

process.is64Bit⁸⁺

is64Bit(): boolean

Checks whether this process is running in a 64-bit environment.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
boolean	Check result. The value true means that the process is running in a 64-bit environment, and false means the opposite.

Example

let result = process.is64Bit();

process.getStartRealtime⁸⁺

getStartRealtime(): number

Obtains the duration, in milliseconds, from the time the system starts to the time the process starts.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
number	Duration obtained, in milliseconds.

Example

let realtime = process.getStartRealtime();

process.getPastCpuTime⁸⁺

getPastCpuTime(): number

Obtains the CPU time (in milliseconds) from the time the process starts to the current time.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
number	CPU time obtained, in milliseconds.

Example

let result = process.getPastCpuTime();

process.abort

abort(): void

Aborts a process and generates a core file. This method will cause a process to exit immediately. Exercise caution when using this method.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Example

process.abort();

process.uptime

uptime(): number

Obtains the running time of this process.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Return value

Type	Description
number	Running time of the process, in seconds.

Example

let time = process.uptime();

process.kill^(deprecated)

kill(signal: number, pid: number): boolean

Sends a signal to the specified process to terminate it.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use kill⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
signal	number	Yes	Signal to send.
pid	number	Yes	PID of the process, to which the signal will be sent.

Return value

Type	Description
boolean	Signal sending result. The value true means that the signal is sent successfully, and false means the opposite.

Example

let pres = process.pid;
let result = process.kill(28, pres);

process.exit^(deprecated)

exit(code: number): void

Terminates this process.

Exercise caution when using this API. After this API is called, the application exits. If the input parameter is not 0, data loss or exceptions may occur.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use exit⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
code	number	Yes	Exit code of the process.

Example

process.exit(0);

process.getUidForName^(deprecated)

getUidForName(v: string): number

Obtains the UID of a user from the user database of the system based on the specified user name.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getUidForName⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
v	string	Yes	User name.

Return value

Type	Description
number	UID of the user.

Example

let pres = process.getUidForName("tool");

process.getThreadPriority^(deprecated)

getThreadPriority(v: number): number

Obtains the thread priority based on the specified TID.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getThreadPriority⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
v	number	Yes	TID.

Return value

Type	Description
number	Priority of the thread. The priority depends on the operating system.

Example

let tid = process.tid;
let pres = process.getThreadPriority(tid);

process.isAppUid^(deprecated)

isAppUid(v: number): boolean

Checks whether a UID belongs to this application.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use isAppUid⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
v	number	Yes	UID.

Return value

Type	Description
boolean	Check result. The value true means that the UID belongs to the application, and false means the opposite.

Example

let result = process.isAppUid(688);

process.getSystemConfig^(deprecated)

getSystemConfig(name: number): number

Obtains the system configuration.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getSystemConfig⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	number	Yes	System configuration parameter name.

Return value

Type	Description
number	System configuration obtained.

Example

let _SC_ARG_MAX = 0;
let pres = process.getSystemConfig(_SC_ARG_MAX);

process.getEnvironmentVar^(deprecated)

getEnvironmentVar(name: string): string

Obtains the value of an environment variable.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getEnvironmentVar⁹⁺ instead.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Environment variable name.

Return value

Type	Description
string	Value of the environment variable.

Example

let pres = process.getEnvironmentVar("PATH");

ProcessManager⁹⁺

Provides APIs for throwing exceptions during the addition of a process.

A ProcessManager object is obtained through its own constructor.

isAppUid⁹⁺

isAppUid(v: number): boolean

Checks whether a UID belongs to this application.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
v	number	Yes	UID. which can be obtained by running process.uid.

Return value

Type	Description
boolean	Check result. The value true means that the UID belongs to the application, and false means the opposite.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

Example

let pro = new process.ProcessManager();
// Use process.uid to obtain the UID.
let pres = process.uid;
let result = pro.isAppUid(pres);
console.log("result: " + result); // result: true

getUidForName⁹⁺

getUidForName(v: string): number

Obtains the UID of a user from the user database of the system based on the specified user name.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
v	string	Yes	User name.

Return value

Type	Description
number	UID of the user. If the user does not exist, -1 is returned.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

Example

let pro = new process.ProcessManager();
let pres = pro .getUidForName("tool");

getThreadPriority⁹⁺

getThreadPriority(v: number): number

Obtains the thread priority based on the specified TID.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
v	number	Yes	TID.

Return value

Type	Description
number	Priority of the thread. The priority depends on the operating system.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

Example

let pro = new process.ProcessManager();
let tid = process.tid;
let pres = pro.getThreadPriority(tid);

getSystemConfig⁹⁺

getSystemConfig(name: number): number

Obtains the system configuration.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	number	Yes	System configuration parameter name.

Return value

Type	Description
number	System configuration obtained. If the system configuration does not exist, -1 is returned.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

Example

let pro = new process.ProcessManager();
let _SC_ARG_MAX = 0;
let pres = pro.getSystemConfig(_SC_ARG_MAX);

getEnvironmentVar⁹⁺

getEnvironmentVar(name: string): string

Obtains the value of an environment variable.

NOTE

If the environment variable does not exist, undefined is returned.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
name	string	Yes	Environment variable name.

Return value

Type	Description
string	Value of the environment variable.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

Example

let pro = new process.ProcessManager();
let pres = pro.getEnvironmentVar("PATH");

exit⁹⁺

exit(code: number): void

Terminates this process.

Exercise caution when using this API. After this API is called, the application exits. If the input parameter is not 0, data loss or exceptions may occur.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
code	number	Yes	Exit code of the process.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

Example

let pro = new process.ProcessManager();
pro.exit(0);

kill⁹⁺

kill(signal: number, pid: number): boolean

Sends a signal to the specified process to terminate it.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
signal	number	Yes	Signal to send.
pid	number	Yes	PID of the process, to which the signal will be sent.

Return value

Type	Description
boolean	Signal sending result. The value true means that the signal is sent successfully, and false means the opposite.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

Example

let pro = new process.ProcessManager();
let pres = process.pid;
let result = pro.kill(28, pres);

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkTS

harmony 鸿蒙Compilation Toolchain Error Codes

harmony 鸿蒙TypeScript Compiler Error Codes

harmony 鸿蒙Utils Error Codes

harmony 鸿蒙js-apis-arkts-collections

harmony 鸿蒙@arkts.math.Decimal (High-Precision Math Library Decimal)

harmony 鸿蒙@arkts.lang (ArkTS Base Capability)

harmony 鸿蒙@arkts.utils (ArkTS Utils)

harmony 鸿蒙@ohos.util.ArrayList (Linear Container ArrayList)

harmony 鸿蒙@ohos.buffer (Buffer)

0 赞

所属分类： 后端技术
本文标签：
版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/IfzXGG

harmony 鸿蒙@ohos.process (Obtaining Process Information)

@ohos.process (Obtaining Process Information)

Modules to Import

Attributes

EventListener

process.isIsolatedProcess⁸⁺

process.is64Bit⁸⁺

process.getStartRealtime⁸⁺

process.getPastCpuTime⁸⁺

process.abort

process.uptime

process.kill^(deprecated)

process.exit^(deprecated)

process.getUidForName^(deprecated)

process.getThreadPriority^(deprecated)

process.isAppUid^(deprecated)

process.getSystemConfig^(deprecated)

process.getEnvironmentVar^(deprecated)

ProcessManager⁹⁺

isAppUid⁹⁺

getUidForName⁹⁺

getThreadPriority⁹⁺

getSystemConfig⁹⁺

getEnvironmentVar⁹⁺

exit⁹⁺

kill⁹⁺

你可能感兴趣的鸿蒙文章

热门推荐

标签云

最新文章

本文目录

harmony 鸿蒙@ohos.process (Obtaining Process Information)

@ohos.process (Obtaining Process Information)

Modules to Import

Attributes

EventListener

process.isIsolatedProcess8+

process.is64Bit8+

process.getStartRealtime8+

process.getPastCpuTime8+

process.abort

process.uptime

process.kill(deprecated)

process.exit(deprecated)

process.getUidForName(deprecated)

process.getThreadPriority(deprecated)

process.isAppUid(deprecated)

process.getSystemConfig(deprecated)

process.getEnvironmentVar(deprecated)

ProcessManager9+

isAppUid9+

getUidForName9+

getThreadPriority9+

getSystemConfig9+

getEnvironmentVar9+

exit9+

kill9+

你可能感兴趣的鸿蒙文章

热门推荐

标签云

最新文章

本文目录

process.isIsolatedProcess⁸⁺

process.is64Bit⁸⁺

process.getStartRealtime⁸⁺

process.getPastCpuTime⁸⁺

process.kill^(deprecated)

process.exit^(deprecated)

process.getUidForName^(deprecated)

process.getThreadPriority^(deprecated)

process.isAppUid^(deprecated)

process.getSystemConfig^(deprecated)

process.getEnvironmentVar^(deprecated)

ProcessManager⁹⁺

isAppUid⁹⁺

getUidForName⁹⁺

getThreadPriority⁹⁺

getSystemConfig⁹⁺

getEnvironmentVar⁹⁺

exit⁹⁺

kill⁹⁺