1# @ohos.systemParameterEnhance (系统参数) 2 3系统参数（SystemParameter）是为各系统服务提供的简单易用的键值对访问接口，各个系统服务可以定义系统参数来描述该服务的状态信息，或者通过系统参数来改变系统服务的行为。其基本操作原语为get和set，通过get可以查询系统参数的值，通过set可以修改系统参数的值。 4详细的系统参数设计原理及定义可参考 5[系统参数](../../../device-dev/subsystems/subsys-boot-init-sysparam.md)。 6 7> **说明：** 8> 9> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 10> 11> - 本模块接口为系统接口。 12> 13> - 由于系统参数都是各个系统服务的内部信息和控制参数，每个系统参数都有各自不同的DAC和MAC访问控制权限，三方应用不能使用此类接口。 14 15## 导入模块 16 17```ts 18import systemparameter from '@ohos.systemParameterEnhance' 19``` 20 21## systemparameter.getSync 22 23getSync(key: string, def?: string): string 24 25获取系统参数Key对应的值。 26 27**系统能力：** SystemCapability.Startup.SystemInfo 28 29**参数：** 30 31| 参数名 | 类型 | 必填 | 说明 | 32| -------- | -------- | -------- | -------- | 33| key | string | 是 | 待查询的系统参数Key。 | 34| def | string | 否 | 默认值。 | 35 36**返回值：** 37 38| 类型 | 说明 | 39| -------- | -------- | 40| string | 系统参数值，若key不存在，返回默认值。若未指定默认值，返回空字符串。 | 41 42**示例：** 43 44```ts 45try { 46 var info = systemparameter.getSync("const.ohos.apiversion"); 47 console.log(JSON.stringify(info)); 48}catch(e){ 49 console.log("getSync unexpected error: " + e); 50} 51``` 52 53## systemparameter.get 54 55get(key: string, callback: AsyncCallback<string>): void 56 57获取系统参数Key对应的值。 58 59**系统能力：** SystemCapability.Startup.SystemInfo 60 61**参数：** 62 63| 参数名 | 类型 | 必填 | 说明 | 64| -------- | -------- | -------- | -------- | 65| key | string | 是 | 待查询的系统参数Key。 | 66| callback | AsyncCallback<string> | 是 | 回调函数。 | 67 68**示例：** 69 70```ts 71try { 72 systemparameter.get("const.ohos.apiversion", function (err, data) { 73 if (err == undefined) { 74 console.log("get test.parameter.key value success:" + data) 75 } else { 76 console.log(" get test.parameter.key value err:" + err.code) 77 }}); 78}catch(e){ 79 console.log("get unexpected error: " + e); 80} 81``` 82 83## systemparameter.get 84 85get(key: string, def: string, callback: AsyncCallback<string>): void 86 87获取系统参数Key对应的值。 88 89**系统能力：** SystemCapability.Startup.SystemInfo 90 91**参数：** 92 93| 参数名 | 类型 | 必填 | 说明 | 94| -------- | -------- | -------- | -------- | 95| key | string | 是 | 待查询的系统参数Key。 | 96| def | string | 是 | 默认值。 | 97| callback | AsyncCallback<string> | 是 | 回调函数。 | 98 99**示例：** 100 101```ts 102try { 103 systemparameter.get("const.ohos.apiversion", "default", function (err, data) { 104 if (err == undefined) { 105 console.log("get test.parameter.key value success:" + data) 106 } else { 107 console.log(" get test.parameter.key value err:" + err.code) 108 } 109 }); 110}catch(e){ 111 console.log("get unexpected error:" + e) 112} 113``` 114 115## systemparameter.get 116 117get(key: string, def?: string): Promise<string> 118 119获取系统参数Key对应的值。 120 121**系统能力：** SystemCapability.Startup.SystemInfo 122 123**参数：** 124 125| 参数名 | 类型 | 必填 | 说明 | 126| -------- | -------- | -------- | -------- | 127| key | string | 是 | 待查询的系统参数Key。 | 128| def | string | 否 | 默认值。 | 129 130**返回值：** 131 132| 类型 | 说明 | 133| -------- | -------- | 134| Promise<string> | Promise示例，用于异步获取结果。 | 135 136**示例：** 137 138```ts 139try { 140 var p = systemparameter.get("const.ohos.apiversion"); 141 p.then(function (value) { 142 console.log("get test.parameter.key success: " + value); 143 }).catch(function (err) { 144 console.log("get test.parameter.key error: " + err.code); 145 }); 146}catch(e){ 147 console.log("get unexpected error: " + e); 148} 149``` 150 151## systemparameter.setSync 152 153setSync(key: string, value: string): void 154 155设置系统参数Key对应的值。 156 157**系统能力：** SystemCapability.Startup.SystemInfo 158 159**参数：** 160 161| 参数名 | 类型 | 必填 | 说明 | 162| -------- | -------- | -------- | -------- | 163| key | string | 是 | 待设置的系统参数Key。 | 164| value | string | 是 | 待设置的系统参数值。 | 165 166**示例：** 167 168```ts 169try { 170 systemparameter.setSync("test.parameter.key", "default"); 171}catch(e){ 172 console.log("set unexpected error: " + e); 173} 174``` 175 176## systemparameter.set 177 178set(key: string, value: string, callback: AsyncCallback<void>): void 179 180设置系统参数Key对应的值。 181 182**系统能力：** SystemCapability.Startup.SystemInfo 183 184**参数：** 185 186| 参数名 | 类型 | 必填 | 说明 | 187| -------- | -------- | -------- | -------- | 188| key | string | 是 | 待设置的系统参数Key。 | 189| value | string | 是 | 待设置的系统参数值。 | 190| callback | AsyncCallback<void> | 是 | 回调函数。 | 191 192**示例：** 193 194```ts 195try { 196 systemparameter.set("test.parameter.key", "testValue", function (err, data) { 197 if (err == undefined) { 198 console.log("set test.parameter.key value success :" + data) 199 } else { 200 console.log("set test.parameter.key value err:" + err.code) 201 }}); 202}catch(e){ 203 console.log("set unexpected error: " + e); 204} 205``` 206 207## systemparameter.set 208 209set(key: string, value: string): Promise<void> 210 211设置系统参数Key对应的值。 212 213**系统能力：** SystemCapability.Startup.SystemInfo 214 215**参数：** 216 217| 参数名 | 类型 | 必填 | 说明 | 218| -------- | -------- | -------- | -------- | 219| key | string | 是 | 待设置的系统参数Key。 | 220| value| string | 是 | 待设置的系统参数值。 | 221 222**返回值：** 223 224| 类型 | 说明 | 225| -------- | -------- | 226| Promise<void> | Promise示例，用于异步获取结果。 | 227 228**示例：** 229 230```ts 231try { 232 var p = systemparameter.set("test.parameter.key", "testValue"); 233 p.then(function (value) { 234 console.log("set test.parameter.key success: " + value); 235 }).catch(function (err) { 236 console.log(" set test.parameter.key error: " + err.code); 237 }); 238}catch(e){ 239 console.log("set unexpected error: " + e); 240} 241``` 242