文件的扩展属性

fs.setxattr(Promise异步返回)

setxattr(path: string, key: string, value: string): Promise

设置文件的扩展属性。

参数：

参数名	类型	必填	说明
path	string	是	目录的应用沙箱路径。
key	string	是	扩展属性的key。
value	string	是	扩展属性的value。

返回值：

类型	说明
Promise	Promise对象。无返回值。

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let filePath = pathDir + "/test.txt";
let attrKey = "user.comment";
let attrValue = "Test file.";

fs.setxattr(filePath, attrKey, attrValue).then(() => {
  console.info("Set extended attribute successfully.");
}).catch((err: BusinessError) => {
  console.error("Failed to set extended attribute with error message: " + err.message + ", error code: " + err.code);
});

fs.setxattrSync

setxattrSync(path: string, key: string, value: string): void;

设置文件的扩展属性。

参数：

参数名	类型	必填	说明
path	string	是	目录的应用沙箱路径。
key	string	是	扩展属性的key。
value	string	是	扩展属性的value。

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let filePath = pathDir + "/test.txt";
let attrKey = "user.comment";
let attrValue = "Test file.";

try {
  fs.setxattrSync(filePath, attrKey, attrValue);
  console.info("Set extended attribute successfully.");
} catch (err) {
  console.error("Failed to set extended attribute with error message: " + err.message + ", error code: " + err.code);
}

fs.getxattr(Promise异步返回)

getxattr(path: string, key: string): Promise

获取文件的扩展属性。

参数：

参数名	类型	必填	说明
path	string	是	目录的应用沙箱路径。
key	string	是	扩展属性的key。

返回值：

类型	说明
Promise	Promise对象。返回扩展属性的value。

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let filePath = pathDir + "/test.txt";
let attrKey = "user.comment";

fs.getxattr(filePath, attrKey).then((attrValue: string) => {
  console.info("Get extended attribute succeed, the value is: " + attrValue);
}).catch((err: BusinessError) => {
  console.error("Failed to get extended attribute with error message: " + err.message + ", error code: " + err.code);
});

fs.getxattrSync

getxattrSync(path: string, key: string): string;

使用同步接口获取文件的扩展属性。

参数：

参数名	类型	必填	说明
path	string	是	目录的应用沙箱路径。
key	string	是	扩展属性的key。

返回值：

类型	说明
key	string对象。返回扩展属性的value。

错误码：

接口抛出错误码的详细介绍请参见基础文件IO错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let filePath = pathDir + "/test.txt";
let attrKey = "user.comment";

try {
  let attrValue = fs.getxattrSync(filePath, attrKey);
  console.info("Get extended attribute succeed, the value is: " + attrValue);
} catch (err) {
  console.error("Failed to get extended attribute with error message: " + err.message + ", error code: " + err.code);
  }