HarmonyOS API：@ohos.resourceManager (资源管理)

joytrian

发布于 2023-4-4 16:05

浏览

0收藏

版本：v3.1 Beta

@ohos.resourceManager (资源管理)

getPluralStringValue⁹⁺

getPluralStringValue(resId: number, num: number, callback: AsyncCallback<string>): void

根据指定数量获取指定ID字符串表示的单复数字符串，使用callback形式返回字符串。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值
num	number	是	数量值
callback	AsyncCallback<string>	是	异步回调，返回根据指定数量获取指定ID字符串表示的单复数字符串

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getPluralStringValue($r("app.plural.test").id, 1, (error, value) => {
      if (error != null) {
          console.log("error is " + error);
      } else {
          let str = value;
      }
  });
} catch (error) {
  console.error(`callback getPluralStringValue failed, error code: ${error.code}, message: ${error.message}.`)
}   1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

getPluralStringValue⁹⁺

getPluralStringValue(resId: number, num: number): Promise<string>

根据指定数量获取对指定ID字符串表示的单复数字符串，使用Promise形式返回字符串。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值
num	number	是	数量值

返回值：

类型	说明
Promise<string>	根据提供的数量获取对应ID字符串表示的单复数字符串

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getPluralStringValue($r("app.plural.test").id, 1).then(value => {
      let str = value;
  }).catch(error => {
      console.log("getPluralStringValue promise error is " + error);
  });
} catch (error) {
  console.error(`callback getPluralStringValue failed, error code: ${error.code}, message: ${error.message}.`)
}  1.
2.
3.
4.
5.
6.
7.
8.
9.

getPluralStringValue⁹⁺

getPluralStringValue(resource: Resource, num: number, callback: AsyncCallback<string>): void

根据指定数量获取指定resource对象表示的单复数字符串，使用callback形式返回字符串。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resource	Resource	是	资源信息
num	number	是	数量值
callback	AsyncCallback<string>	是	异步回调，返回根据指定数量获取指定resource对象表示的单复数字符串

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

示例：

let resource = {
    bundleName: "com.example.myapplication",
    moduleName: "entry",
    id: $r('app.plural.test').id
};
try {
  this.context.resourceManager.getPluralStringValue(resource, 1, (error, value) => {
      if (error != null) {
          console.log("error is " + error);
      } else {
          let str = value;
      }
  });
} catch (error) {
  console.error(`callback getPluralStringValue failed, error code: ${error.code}, message: ${error.message}.`)
}  1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

getPluralString⁹⁺

getPluralString(resource: Resource, num: number): Promise<string>

根据指定数量获取对指定resource对象表示的单复数字符串，使用Promise形式返回字符串。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resource	Resource	是	资源信息
num	number	是	数量值

返回值：

类型	说明
Promise<string>	根据提供的数量获取对应resource对象表示的单复数字符串

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

示例：

let resource = {
    bundleName: "com.example.myapplication",
    moduleName: "entry",
    id: $r('app.plural.test').id
};
try {
  this.context.resourceManager.getPluralString(resource, 1).then(value => {
      let str = value;
  }).catch(error => {
      console.log("getPluralString promise error is " + error);
  });
} catch (error) {
  console.error(`callback getPluralStringValue failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.

getRawFileContent⁹⁺

getRawFileContent(path: string, callback: AsyncCallback<Uint8Array>): void

用户获取resources/rawfile目录下对应的rawfile文件内容，使用callback形式返回字节数组。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
path	string	是	rawfile文件路径
callback	AsyncCallback<Uint8Array>	是	异步回调，用于返回获取的rawfile文件内容

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001005	If the resource not found by path.

示例：

try {
  this.context.resourceManager.getRawFileContent("test.xml", (error, value) => {
      if (error != null) {
          console.log("error is " + error);
      } else {
          let rawFile = value;
      }
  });
} catch (error) {
  console.error(`callback getRawFileContent failed, error code: ${error.code}, message: ${error.message}.`)
}
    1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.

getRawFileContent⁹⁺

getRawFileContent(path: string): Promise<Uint8Array>

用户获取resources/rawfile目录下对应的rawfile文件内容，使用Promise形式返回字节数组。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
path	string	是	rawfile文件路径

返回值：

类型	说明
Promise<Uint8Array>	rawfile文件内容

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001005	If the resource not found by path.

示例：

try {
  this.context.resourceManager.getRawFileContent("test.xml").then(value => {
      let rawFile = value;
  }).catch(error => {
      console.log("getRawFileContent promise error is " + error);
  });
} catch (error) {
  console.error(`promise getRawFileContent failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.

getRawFd⁹⁺

getRawFd(path: string, callback: AsyncCallback<RawFileDescriptor>): void

用户获取resources/rawfile目录下对应rawfile文件的descriptor，使用callback形式返回。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
path	string	是	rawfile文件路径
callback	AsyncCallback<RawFileDescriptor>	是	异步回调，用于返回获取的rawfile文件的descriptor

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001005	If the resource not found by path.

示例：

try {
  this.context.resourceManager.getRawFd("test.xml", (error, value) => {
      if (error != null) {
          console.log(`callback getRawFd failed error code: ${error.code}, message: ${error.message}.`);
      } else {
          let fd = value.fd;
          let offset = value.offset;
          let length = value.length;
      }
  });
} catch (error) {
    console.error(`callback getRawFd failed, error code: ${error.code}, message: ${error.message}.`)
};1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.

getRawFd⁹⁺

getRawFd(path: string): Promise<RawFileDescriptor>

用户获取resources/rawfile目录下对应rawfile文件的descriptor，使用Promise形式返回。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
path	string	是	rawfile文件路径

返回值：

类型	说明
Promise<RawFileDescriptor>	rawfile文件descriptor

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001005	If the resource not found by path.

示例：

try {
  this.context.resourceManager.getRawFd("test.xml").then(value => {
      let fd = value.fd;
      let offset = value.offset;
      let length = value.length;
  }).catch(error => {
      console.log(`promise getRawFd error error code: ${error.code}, message: ${error.message}.`);
  });
} catch (error) {
  console.error(`promise getRawFd failed, error code: ${error.code}, message: ${error.message}.`);
};1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

closeRawFileDescriptor⁸⁺

closeRawFileDescriptor(path: string, callback: AsyncCallback<void>): void

用户关闭resources/rawfile目录下rawfile文件的descriptor，使用callback形式返回。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
path	string	是	rawfile文件路径
callback	AsyncCallback<void>	是	异步回调

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.closeRawFileDescriptor("test.xml", (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        }
    });
});1.
2.
3.
4.
5.
6.
7.

closeRawFileDescriptor⁸⁺

closeRawFileDescriptor(path: string): Promise<void>

用户关闭resources/rawfile目录下rawfile文件的descriptor，使用Promise形式返回。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
path	string	是	rawfile文件路径

返回值：

类型	说明
Promise<void>	无返回值

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.closeRawFileDescriptor("test.xml").then(value => {
        let result = value;
    }).catch(error => {
        console.log("closeRawFileDescriptor promise error is " + error);
    });
});1.
2.
3.
4.
5.
6.
7.

closeRawFd⁹⁺

closeRawFd(path: string, callback: AsyncCallback<void>): void

用户关闭resources/rawfile目录下rawfile文件的descriptor，使用callback形式返回。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
path	string	是	rawfile文件路径
callback	AsyncCallback<void>	是	异步回调

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001005	The resource not found by path.

示例：

try {
  this.context.resourceManager.closeRawFd("test.xml", (error, value) => {
      if (error != null) {
          console.log("error is " + error);
      }
  });
} catch (error) {
  console.error(`callback closeRawFd failed, error code: ${error.code}, message: ${error.message}.`)
}
    1.
2.
3.
4.
5.
6.
7.
8.
9.
10.

closeRawFd⁸⁺

closeRawFd(path: string): Promise<void>

用户关闭resources/rawfile目录下rawfile文件的descriptor，使用Promise形式返回。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
path	string	是	rawfile文件路径

返回值：

类型	说明
Promise<void>	无返回值

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001005	If the resource not found by path.

示例：

try {
  this.context.resourceManager.closeRawFd("test.xml").then(value => {
      let result = value;
  }).catch(error => {
      console.log("closeRawFd promise error is " + error);
  });
} catch (error) {
  console.error(`promise closeRawFd failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.

release⁷⁺

release()

用户释放创建的resourceManager。

系统能力：SystemCapability.Global.ResourceManager

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.release();
});1.
2.
3.

getStringByName⁹⁺

getStringByName(resName: string, callback: AsyncCallback<string>): void

用户获取指定资源名称对应的字符串，使用callback形式返回字符串。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resName	string	是	资源名称
callback	AsyncCallback<string>	是	异步回调，用于返回获取的字符串

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getStringByName("test", (error, value) => {
      if (error != null) {
           console.log("error is " + error);
      } else {
          let string = value;
      }
  });
} catch (error) {
  console.error(`callback getStringByName failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

getStringByName⁹⁺

getStringByName(resName: string): Promise<string>

用户获取指定资源名称对应的字符串，使用Promise形式返回字符串。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resName	string	是	资源名称

返回值：

类型	说明
Promise<string>	资源名称对应的字符串

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getStringByName("test").then(value => {
      let string = value;
  }).catch(error => {
      console.log("getStringByName promise error is " + error);
  });
} catch (error) {
  console.error(`promise getStringByName failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.

getStringArrayByName⁹⁺

getStringArrayByName(resName: string, callback: AsyncCallback<Array<string>>): void

用户获取指定资源名称对应的字符串数组，使用callback形式返回字符串数组。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resName	string	是	资源名称
callback	AsyncCallback<Array<string>>	是	异步回调，用于返回获取的字符串数组

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getStringArrayByName("test", (error, value) => {
      if (error != null) {
          console.log("error is " + error);
      } else {
          let strArray = value;
      }
  });
} catch (error) {
  console.error(`callback getStringArrayByName failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

getStringArrayByName⁹⁺

getStringArrayByName(resName: string): Promise<Array<string>>

用户获取指定资源名称对应的字符串数组，使用Promise形式返回字符串数组。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resName	string	是	资源名称

返回值：

类型	说明
Promise<Array<string>>	资源名称对应的字符串数组

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getStringArrayByName("test").then(value => {
      let strArray = value;
  }).catch(error => {
      console.log("getStringArrayByName promise error is " + error);
  });
} catch (error) {
  console.error(`promise getStringArrayByName failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.

getMediaByName⁹⁺

getMediaByName(resName: string, callback: AsyncCallback<Uint8Array>): void

用户获取指定资源ID对应的媒体文件内容，使用callback形式返回字节数组。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resName	string	是	资源名称
callback	AsyncCallback<Uint8Array>	是	异步回调，用于返回获取的媒体文件内容

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getMediaByName("test", (error, value) => {
      if (error != null) {
          console.log("error is " + error);
      } else {
          let media = value;
      }
  });
} catch (error) {
  console.error(`callback getMediaByName failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

getMediaByName⁹⁺

getMediaByName(resName: string): Promise<Uint8Array>

用户获取指定资源名称对应的媒体文件内容，使用Promise形式返回字节数组。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resName	string	是	资源名称

返回值：

类型	说明
Promise<Uint8Array>	资源名称对应的媒体文件内容

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getMediaByName("test").then(value => {
      let media = value;
  }).catch(error => {
      console.log("getMediaByName promise error is " + error);
  });
} catch (error) {
  console.error(`promise getMediaByName failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.

getMediaBase64ByName⁹⁺

getMediaBase64ByName(resName: string, callback: AsyncCallback<string>): void

用户获取指定资源名称对应的图片资源Base64编码，使用callback形式返回字符串。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resName	string	是	资源名称
callback	AsyncCallback<string>	是	异步回调，用于返回获取的图片资源Base64编码

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getMediaBase64ByName("test", (error, value) => {
      if (error != null) {
          console.log("error is " + error);
      } else {
          let media = value;
      }
  });
} catch (error) {
  console.error(`callback getMediaBase64ByName failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

getMediaBase64ByName⁹⁺

getMediaBase64ByName(resName: string): Promise<string>

用户获取指定资源名称对应的图片资源Base64编码，使用Promise形式返回字符串。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resName	string	是	资源名称

返回值：

类型	说明
Promise<string>	资源名称对应的图片资源Base64编码

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getMediaBase64ByName("test").then(value => {
      let media = value;
  }).catch(error => {
      console.log("getMediaBase64ByName promise error is " + error);
  });
} catch (error) {
  console.error(`promise getMediaBase64ByName failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.

getPluralStringByName⁹⁺

getPluralStringByName(resName: string, num: number, callback: AsyncCallback<string>): void

根据传入的数量值，获取资源名称对应的字符串资源，使用callback形式返回字符串。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resName	string	是	资源名称
num	number	是	数量值
callback	AsyncCallback<string>	是	异步回调，返回根据传入的数量值获取资源名称对应的字符串资源

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getPluralStringByName("test", 1, (error, value) => {
      if (error != null) {
          console.log("error is " + error);
      } else {
          let str = value;
      }
  });
} catch (error) {
  console.error(`callback getPluralStringByName failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

getPluralStringByName⁹⁺

getPluralStringByName(resName: string, num: number): Promise<string>

根据传入的数量值，获取资源名称对应的字符串资源，使用Promise形式返回字符串。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resName	string	是	资源名称
num	number	是	数量值

返回值：

类型	说明
Promise<string>	根据传入的数量值获取资源名称对应的字符串资源

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getPluralStringByName("test", 1).then(value => {
    let str = value;
  }).catch(error => {
    console.log("getPluralStringByName promise error is " + error);
  });
} catch (error) {
  console.error(`promise getPluralStringByName failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.

getStringSync⁹⁺

getStringSync(resId: number): string

用户获取指定资源ID对应的字符串，使用同步方式返回字符串。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值

返回值：

类型	说明
string	资源ID值对应的字符串

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getStringSync($r('app.string.test').id);
} catch (error) {
  console.error(`getStringSync failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.

getStringSync⁹⁺

getStringSync(resource: Resource): string

用户获取指定resource对象对应的字符串，使用同步方式返回字符串。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resource	Resource	是	资源信息

返回值：

类型	说明
string	resource对象对应的字符串

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

示例：

let resource = {
    bundleName: "com.example.myapplication",
    moduleName: "entry",
    id: $r('app.string.test').id
};
try {
  this.context.resourceManager.getStringSync(resource);
} catch (error) {
  console.error(`getStringSync failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.

getStringByNameSync⁹⁺

getStringByNameSync(resName: string): string

用户获取指定资源名称对应的字符串，使用同步方式返回字符串。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resName	string	是	资源名称

返回值：

类型	说明
string	资源名称对应的字符串

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getStringByNameSync("test");
} catch (error) {
  console.error(`getStringByNameSync failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.

getBoolean⁹⁺

getBoolean(resId: number): boolean

使用同步方式，返回获取指定资源ID对应的布尔结果。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值

返回值：

类型	说明
boolean	资源ID值对应的布尔结果

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getBoolean($r('app.boolean.boolean_test').id);
} catch (error) {
  console.error(`getBoolean failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.

getBoolean⁹⁺

getBoolean(resource: Resource): boolean

使用同步方式，返回获取指定resource对象对应的布尔结果。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resource	Resource	是	资源信息

返回值：

类型	说明
boolean	resource对象对应的布尔结果

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

示例：

let resource = {
    bundleName: "com.example.myapplication",
    moduleName: "entry",
    id: $r('app.boolean.boolean_test').id
};
try {
  this.context.resourceManager.getBoolean(resource);
} catch (error) {
  console.error(`getBoolean failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.

getBooleanByName⁹⁺

getBooleanByName(resName: string): boolean

使用同步方式，返回获取指定资源名称对应的布尔结果

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resName	string	是	资源名称

返回值：

类型	说明
boolean	资源名称对应的布尔结果

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getBooleanByName("boolean_test");
} catch (error) {
  console.error(`getBooleanByName failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.

getNumber⁹⁺

getNumber(resId: number): number

用户获取指定资源ID对应的integer数值或者float数值，使用同步方式返回资源对应的数值。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值

返回值：

类型	说明
number	资源ID值对应的数值

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getNumber($r('app.integer.integer_test').id);
} catch (error) {
  console.error(`getNumber failed, error code: ${error.code}, message: ${error.message}.`)
}

try {
  this.context.resourceManager.getNumber($r('app.float.float_test').id);
} catch (error) {
  console.error(`getNumber failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

getNumber⁹⁺

getNumber(resource: Resource): number

用户获取指定resource对象对应的integer数值或者float数值，使用同步方式返回资源对应的数值。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resource	Resource	是	资源信息

返回值：

类型	说明
number	resource对象对应的数值

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

示例：

let resource = {
    bundleName: "com.example.myapplication",
    moduleName: "entry",
    id: $r('app.integer.integer_test').id
};
try {
  this.context.resourceManager.getNumber(resource);
} catch (error) {
  console.error(`getNumber failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.

getNumberByName⁹⁺

getNumberByName(resName: string): number

用户获取指定资源名称对应的integer数值或者float数值，使用同步方式资源对应的数值。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resName	string	是	资源名称

返回值：

类型	说明
number	资源名称对应的数值

以下错误码的详细介绍请参见资源管理错误码。

错误码：

错误码ID	错误信息
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

示例：

try {
  this.context.resourceManager.getNumberByName("integer_test");
} catch (error) {
  console.error(`getNumberByName failed, error code: ${error.code}, message: ${error.message}.`)
}

try {
  this.context.resourceManager.getNumberByName("float_test");
} catch (error) {
  console.error(`getNumberByName failed, error code: ${error.code}, message: ${error.message}.`)
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

getString^(deprecated)

getString(resId: number, callback: AsyncCallback<string>): void

用户获取指定资源ID对应的字符串，使用callback形式返回字符串。

从API version 9开始不再维护，建议使用getStringValue代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值
callback	AsyncCallback<string>	是	异步回调，用于返回获取的字符串

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.getString($r('app.string.test').id, (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let str = value;
        }
    });
});1.
2.
3.
4.
5.
6.
7.
8.
9.

getString^(deprecated)

getString(resId: number): Promise<string>

用户获取指定资源ID对应的字符串，使用Promise形式返回字符串。

从API version 9开始不再维护，建议使用getStringValue代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值

返回值：

类型	说明
Promise<string>	资源ID值对应的字符串

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.getString($r('app.string.test').id).then(value => {
        let str = value;
    }).catch(error => {
        console.log("getstring promise error is " + error);
    });
});1.
2.
3.
4.
5.
6.
7.

getStringArray^(deprecated)

getStringArray(resId: number, callback: AsyncCallback<Array<string>>): void

用户获取指定资源ID对应的字符串数组，使用callback形式返回字符串数组。

从API version 9开始不再维护，建议使用getStringArrayValue代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值
callback	AsyncCallback<Array<string>>	是	异步回调，用于返回获取的字符串数组

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.getStringArray($r('app.strarray.test').id, (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let strArray = value;
        }
    });
});1.
2.
3.
4.
5.
6.
7.
8.
9.

getStringArray^(deprecated)

getStringArray(resId: number): Promise<Array<string>>

用户获取指定资源ID对应的字符串数组，使用Promise形式返回字符串数组。

从API version 9开始不再维护，建议使用getStringArrayValue代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值

返回值：

类型	说明
Promise<Array<string>>	资源ID值对应的字符串数组

示例：

resourceManager.getResourceManager((error, mgr) => {
     mgr.getStringArray($r('app.strarray.test').id).then(value => {
        let strArray = value;
    }).catch(error => {
        console.log("getStringArray promise error is " + error);
    });
});1.
2.
3.
4.
5.
6.
7.

getMedia^(deprecated)

getMedia(resId: number, callback: AsyncCallback<Uint8Array>): void

用户获取指定资源ID对应的媒体文件内容，使用callback形式返回字节数组。

从API version 9开始不再维护，建议使用getMediaContent代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值
callback	AsyncCallback<Uint8Array>	是	异步回调，用于返回获取的媒体文件内容

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.getMedia($r('app.media.test').id, (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let media = value;
        }
    });
});1.
2.
3.
4.
5.
6.
7.
8.
9.

getMedia^(deprecated)

getMedia(resId: number): Promise<Uint8Array>

用户获取指定资源ID对应的媒体文件内容，使用Promise形式返回字节数组。

从API version 9开始不再维护，建议使用getMediaContent代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值

返回值：

类型	说明
Promise<Uint8Array>	资源ID值对应的媒体文件内容

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.getMedia($r('app.media.test').id).then(value => {
        let media = value;
    }).catch(error => {
        console.log("getMedia promise error is " + error);
    });
});1.
2.
3.
4.
5.
6.
7.

getMediaBase64^(deprecated)

getMediaBase64(resId: number, callback: AsyncCallback<string>): void

用户获取指定资源ID对应的图片资源Base64编码，使用callback形式返回字符串。

从API version 9开始不再维护，建议使用getMediaContentBase64代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值
callback	AsyncCallback<string>	是	异步回调，用于返回获取的图片资源Base64编码

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.getMediaBase64($r('app.media.test').id, (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let media = value;
        }
    });
});1.
2.
3.
4.
5.
6.
7.
8.
9.

getMediaBase64^(deprecated)

getMediaBase64(resId: number): Promise<string>

用户获取指定资源ID对应的图片资源Base64编码，使用Promise形式返回字符串。

从API version 9开始不再维护，建议使用getMediaContentBase64代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值

返回值：

类型	说明
Promise<string>	资源ID值对应的图片资源Base64编码

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.getMediaBase64($r('app.media.test').id).then(value => {
        let media = value;
    }).catch(error => {
        console.log("getMediaBase64 promise error is " + error);
    });
});1.
2.
3.
4.
5.
6.
7.

getPluralString^(deprecated)

getPluralString(resId: number, num: number): Promise<string>

根据指定数量获取对指定ID字符串表示的单复数字符串，使用Promise形式返回字符串。

从API version 9开始不再维护，建议使用getPluralStringValue代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值
num	number	是	数量值

返回值：

类型	说明
Promise<string>	根据提供的数量获取对应ID字符串表示的单复数字符串

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.getPluralString($r("app.plural.test").id, 1).then(value => {
        let str = value;
    }).catch(error => {
        console.log("getPluralString promise error is " + error);
    });
});1.
2.
3.
4.
5.
6.
7.

getPluralString^(deprecated)

getPluralString(resId: number, num: number, callback: AsyncCallback<string>): void

根据指定数量获取指定ID字符串表示的单复数字符串，使用callback形式返回字符串。

从API version 9开始不再维护，建议使用getPluralStringValue代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
resId	number	是	资源ID值
num	number	是	数量值
callback	AsyncCallback<string>	是	异步回调，返回根据指定数量获取指定ID字符串表示的单复数字符串

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.getPluralString($r("app.plural.test").id, 1, (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let str = value;
        }
    });
});1.
2.
3.
4.
5.
6.
7.
8.
9.

getRawFile^(deprecated)

getRawFile(path: string, callback: AsyncCallback<Uint8Array>): void

用户获取resources/rawfile目录下对应的rawfile文件内容，使用callback形式返回字节数组。

从API version 9开始不再维护，建议使用getRawFileContent代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
path	string	是	rawfile文件路径
callback	AsyncCallback<Uint8Array>	是	异步回调，用于返回获取的rawfile文件内容

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.getRawFile("test.xml", (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let rawFile = value;
        }
    });
});1.
2.
3.
4.
5.
6.
7.
8.
9.

getRawFile^(deprecated)

getRawFile(path: string): Promise<Uint8Array>

用户获取resources/rawfile目录下对应的rawfile文件内容，使用Promise形式返回字节数组。

从API version 9开始不再维护，建议使用getRawFileContent代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
path	string	是	rawfile文件路径

返回值：

类型	说明
Promise<Uint8Array>	rawfile文件内容

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.getRawFile("test.xml").then(value => {
        let rawFile = value;
    }).catch(error => {
        console.log("getRawFile promise error is " + error);
    });
});1.
2.
3.
4.
5.
6.
7.

getRawFileDescriptor^(deprecated)

getRawFileDescriptor(path: string, callback: AsyncCallback<RawFileDescriptor>): void

用户获取resources/rawfile目录下对应rawfile文件的descriptor，使用callback形式返回。

从API version 9开始不再维护，建议使用getRawFd代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
path	string	是	rawfile文件路径
callback	AsyncCallback<RawFileDescriptor>	是	异步回调，用于返回获取的rawfile文件的descriptor

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.getRawFileDescriptor("test.xml", (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let fd = value.fd;
            let offset = value.offset;
            let length = value.length;
        }
    });
});1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

getRawFileDescriptor^(deprecated)

getRawFileDescriptor(path: string): Promise<RawFileDescriptor>

用户获取resources/rawfile目录下对应rawfile文件的descriptor，使用Promise形式返回。

从API version 9开始不再维护，建议使用getRawFd代替。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名	类型	必填	说明
path	string	是	rawfile文件路径

返回值：

类型	说明
Promise<RawFileDescriptor>	rawfile文件descriptor

示例：

resourceManager.getResourceManager((error, mgr) => {
    mgr.getRawFileDescriptor("test.xml").then(value => {
        let fd = value.fd;
        let offset = value.offset;
        let length = value.length;
    }).catch(error => {
        console.log("getRawFileDescriptor promise error is " + error);
    });
});1.
2.
3.
4.
5.
6.
7.
8.
9.

文章转载自：https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-resource-manager-0000001478181625-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001478181625__getrawfiledescriptordeprecated

分类

标签

已于2023-4-4 16:05:59修改

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：@ohos.resourceManager (资源管理)

@ohos.resourceManager (资源管理)

getPluralStringValue9+

getPluralStringValue9+

getPluralStringValue9+

getPluralString9+

getRawFileContent9+

getRawFileContent9+

getRawFd9+

getRawFd9+

closeRawFileDescriptor8+

closeRawFileDescriptor8+

closeRawFd9+

closeRawFd8+

release7+

getStringByName9+

getStringByName9+

getStringArrayByName9+

getStringArrayByName9+

getMediaByName9+

getMediaByName9+

getMediaBase64ByName9+

getMediaBase64ByName9+

getPluralStringByName9+

getPluralStringByName9+

getStringSync9+

getStringSync9+

getStringByNameSync9+

getBoolean9+

getBoolean9+

getBooleanByName9+

getNumber9+

getNumber9+

getNumberByName9+

getString(deprecated)

getString(deprecated)

getStringArray(deprecated)

getStringArray(deprecated)

getMedia(deprecated)

getMedia(deprecated)

getMediaBase64(deprecated)

getMediaBase64(deprecated)

getPluralString(deprecated)

getPluralString(deprecated)

getRawFile(deprecated)

getRawFile(deprecated)

getRawFileDescriptor(deprecated)

getRawFileDescriptor(deprecated)

目录

订阅鸿蒙技术特刊，精选内容抢先看

getPluralStringValue⁹⁺

getPluralStringValue⁹⁺

getPluralStringValue⁹⁺

getPluralString⁹⁺

getRawFileContent⁹⁺

getRawFileContent⁹⁺

getRawFd⁹⁺

getRawFd⁹⁺

closeRawFileDescriptor⁸⁺

closeRawFileDescriptor⁸⁺

closeRawFd⁹⁺

closeRawFd⁸⁺

release⁷⁺

getStringByName⁹⁺

getStringByName⁹⁺

getStringArrayByName⁹⁺

getStringArrayByName⁹⁺

getMediaByName⁹⁺

getMediaByName⁹⁺

getMediaBase64ByName⁹⁺

getMediaBase64ByName⁹⁺

getPluralStringByName⁹⁺

getPluralStringByName⁹⁺

getStringSync⁹⁺

getStringSync⁹⁺

getStringByNameSync⁹⁺

getBoolean⁹⁺

getBoolean⁹⁺

getBooleanByName⁹⁺

getNumber⁹⁺

getNumber⁹⁺

getNumberByName⁹⁺

getString^(deprecated)

getString^(deprecated)

getStringArray^(deprecated)

getStringArray^(deprecated)

getMedia^(deprecated)

getMedia^(deprecated)

getMediaBase64^(deprecated)

getMediaBase64^(deprecated)

getPluralString^(deprecated)

getPluralString^(deprecated)

getRawFile^(deprecated)

getRawFile^(deprecated)

getRawFileDescriptor^(deprecated)

getRawFileDescriptor^(deprecated)