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