系统属性

About 14 min

系统属性

导入模块

import parameter from '@ohos.systemParameter'
1

权限列表

方法

getSync(key: string, def?: string)

获取系统属性Key对应的值。

参数:

参数名

类型

必填

说明

key

string

待查询的系统属性Key。

def

string

默认值。

返回值:

类型

说明

string

系统属性值,若key不存在,返回默认值。若未指定默认值,返回空字符串。

示例:

try {
    var info = parameter.getSync("test.parameter.key");
    console.log(JSON.stringify(info));
}catch(e){
    console.log("getSync unexpected error: " + e);
}
1
2
3
4
5
6

get(key: string, callback: AsyncCallback<string>)

获取系统属性Key对应的值。

参数:

参数名

类型

必填

说明

key

string

待查询的系统属性Key。

callback

AsyncCallback<string>

回调函数。

返回值:

示例:

try {
    parameter.get("test.parameter.key", function (err, data) {
    if (err == undefined) {
        console.log("get test.parameter.key value success:" + data)
    } else {
        console.log(" get test.parameter.key value err:" + err.code)
    }});
}catch(e){
    console.log("get unexpected error: " + e);
}
1
2
3
4
5
6
7
8
9
10

get(key: string, def: string, callback: AsyncCallback<string>)

获取系统属性Key对应的值。

参数:

参数名

类型

必填

说明

key

string

待查询的系统属性Key。

def

string

默认值。

callback

AsyncCallback<string>

回调函数。

返回值:

示例:

try {
    parameter.get("test.parameter.key", "default", function (err, data) {
        if (err == undefined) {
            console.log("get test.parameter.key value success:" + data)
        } else {
            console.log(" get test.parameter.key value err:" + err.code)
        }
    });
}catch(e){
    console.log("get unexpected error:" + e)
}
1
2
3
4
5
6
7
8
9
10
11

get(key: string, def?: string)

获取系统属性Key对应的值。

参数:

参数名

类型

必填

说明

key

string

待查询的系统属性Key。

def

string

默认值。

返回值:

类型

说明

Promise<string>

Promise示例,用于异步获取结果。

示例:

try {
    var p = parameter.get("test.parameter.key");
    p.then(function (value) {
        console.log("get test.parameter.key success: " + value);
    }).catch(function (err) {
        console.log("get test.parameter.key error: " + err.code);
    });
}catch(e){
    console.log("get unexpected error: " + e);
}
1
2
3
4
5
6
7
8
9
10

setSync(key: string, value: string)

设置系统属性Key对应的值。

参数:

参数名

类型

必填

说明

key

string

待设置的系统属性Key。

value

string

待设置的系统属性值。

返回值:

示例:

try {
    parameter.setSync("test.parameter.key", "default");
}catch(e){
    console.log("set unexpected error: " + e);
}
1
2
3
4
5

set(key: string, value: string, callback: AsyncCallback<void>)

设置系统属性Key对应的值。

参数:

参数名

类型

必填

说明

key

string

待查询的系统属性Key。

def

string

默认值。

callback

AsyncCallback<void>

回调函数。

返回值:

示例:

try {
    parameter.set("test.parameter.key", "testValue", function (err, data) {
    if (err == undefined) {
        console.log("set test.parameter.key value success :" + data)
    } else {
        console.log("set test.parameter.key value err:" + err.code)
    }});
}catch(e){
    console.log("set unexpected error: " + e);
}
1
2
3
4
5
6
7
8
9
10

set(key: string, def?: string)

设置系统属性Key对应的值。

参数:

参数名

类型

必填

说明

key

string

待查询的系统属性Key。

def

string

默认值。

返回值:

类型

说明

Promise<string>

Promise示例,用于异步获取结果。

示例:

try {
    var p = para.set("test.parameter.key", "testValue");
    p.then(function (value) {
        console.log("set test.parameter.key success: " + value);
    }).catch(function (err) {
        console.log(" set test.parameter.key error: " + err.code);
    });
}catch(e){
    console.log("set unexpected error: " + e);
}
1
2
3
4
5
6
7
8
9
10