鸿蒙语言基础类库:【@system.file (文件存储)】

news2024/12/24 2:32:32

文件存储

说明:

  • 从API Version 6开始,该接口不再维护,推荐使用新接口[@ohos.fileio]。
  • 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import file from '@system.file';

file.move

move(Object): void

将指定文件移动到其他指定位置。

系统能力: SystemCapability.FileManagement.File.FileIO

参数:

参数名类型必填说明
srcUristring要移动的文件的uri。字符串最大长度为128,且不能包含“"*+,:;<=>?[]
dstUristring文件要移动到的位置的uri。字符串最大长度为128,且不能包含“"*+,:;<=>?[]
successFunction接口调用成功的回调函数,返回文件要移动到的位置的uri。
failFunction接口调用失败的回调函数。
completeFunction接口调用结束的回调函数。

fail返回错误代码:

错误码说明
202出现参数错误。
300出现I/O错误。
301文件或目录不存在。

示例:

export default {    
  move() {        
    file.move({            
      srcUri: 'internal://app/myfiles1',            
      dstUri: 'internal://app/myfiles2',            
      success: function(uri) {                
        console.log('call success callback success');            
      },            
      fail: function(data, code) {                
        console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
      },        
    });    
  }
}

file.copy

copy(Object): void

将指定文件拷贝并存储到指定位置。

系统能力: SystemCapability.FileManagement.File.FileIO

参数:

参数名类型必填说明
srcUristring要拷贝的文件的uri。
dstUristring文件要拷贝到的位置的uri。 不支持用应用资源路径或tmp类型的uri。
successFunction接口调用成功的回调函数,返回文件要拷贝到的位置的uri。
failFunction接口调用失败的回调函数。
completeFunction接口调用结束的回调函数。

fail返回错误代码:

错误码说明
202出现参数错误。
300出现I/O错误。
301文件或目录不存在。

示例:

export default {    
  copy() {        
    file.copy({            
      srcUri: 'internal://app/file.txt',            
      dstUri: 'internal://app/file_copy.txt',            
      success: function(uri) {                
        console.log('call success callback success');            
      },            
      fail: function(data, code) {                
        console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
      },
    });    
  }
}

file.list

list(Object): void

获取指定路径下全部文件的列表。

系统能力: SystemCapability.FileManagement.File.FileIO

参数:

参数名类型必填说明
uristring目录uri。字符串最大长度为128,且不能包含“"*+,:;<=>?[]
successFunction接口调用成功的回调函数。
failFunction接口调用失败的回调函数。
completeFunction接口调用结束的回调函数。

success返回值:

参数名类型说明
fileListArray获取的文件列表,其中每个文件的信息的格式为: { uri:‘file1’, lastModifiedTime:1589965924479, length:10240, type: ‘file’ }

表1 FileInfo

参数名类型说明
uristring文件的 uri。
lastModifiedTimenumber文件上一次保存时的时间戳,显示从1970/01/01 00:00:00 GMT到当前时间的毫秒数。
lengthnumber文件的大小,单位为字节。
typestring文件的类型,可选值为: - dir:目录; - file:文件。

fail返回错误代码:

错误码说明
202出现参数错误。
300出现I/O错误。
301文件或目录不存在。

示例:

export default {    
  list() {        
    file.list({            
      uri: 'internal://app/pic',            
      success: function(data) {                
        console.log(JSON.stringify(data.fileList));            
      },            
      fail: function(data, code) {                
        console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
      },        
    });    
  }
}

file.get

get(Object): void

获取指定本地文件的信息。

系统能力: SystemCapability.FileManagement.File.FileIO

参数:

参数名类型必填说明
uristring文件的uri。
recursiveboolean是否进行递归获取子目录文件列表,缺省为false。
successFunction接口调用成功的回调函数。
failFunction接口调用失败的回调函数。
completeFunction接口调用结束的回调函数。

success返回值:

参数名类型说明
uristring文件的uri。
lengthnumber文件字节长。
lastModifiedTimenumber文件保存时的时间戳,从1970/01/01 00:00:00到当前时间的毫秒数。
typestring文件类型,可选值为: - dir:目录; - file:文件。
subFilesArray文件列表。

fail返回错误代码:

错误码说明
202出现参数错误。
300出现I/O错误。
301文件或目录不存在。

示例:

export default {    
  get() {        
    file.get({            
      uri: 'internal://app/file',            
      success: function(data) {                
        console.log(data.uri);            
      },            
      fail: function(data, code) {                
        console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
      },
    });    
  }
}

file.delete

delete(Object): void

删除本地文件。

系统能力: SystemCapability.FileManagement.File.FileIO

参数:

参数名类型必填说明
uristring删除文件的uri,不能是应用资源路径。
successFunction接口调用成功的回调函数。
failFunction接口调用失败的回调函数。
completeFunction接口调用结束的回调函数。

fail返回错误代码:

错误码说明
202参数错误。
300I/O错误。
301文件或目录不存在。

示例:

export default {    
  delete() {        
    file.delete({            
      uri: 'internal://app/my_file',            
      success: function() {                
        console.log('call delete success.');            
      },            
      fail: function(data, code) {                
        console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
      },
    });    
  }
}

file.writeText

writeText(Object): void

写文本内容到指定文件。仅支持文本文档读写。

系统能力: SystemCapability.FileManagement.File.FileIO

参数:

参数名类型必填说明
uristring本地文件uri,如果文件不存在会创建文件。
textstring写入的字符串。
encodingstring编码格式,默认为UTF-8。
appendboolean是否追加模式,默认为false。
successFunction接口调用成功的回调函数。
failFunction接口调用失败的回调函数。
completeFunction接口调用结束的回调函数。

fail返回错误代码:

错误码说明
202参数错误。
300I/O错误。

示例:

export default {    
  writeText() {        
    file.writeText({            
      uri: 'internal://app/test.txt',            
      text: 'Text that just for test.',            
      success: function() {                
        console.log('call writeText success.');            
      },            
      fail: function(data, code) {                
        console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
      },        
    });    
  }
}

file.writeArrayBuffer

writeArrayBuffer(Object): void

写Buffer内容到指定文件。仅支持文本文档读写。

系统能力: SystemCapability.FileManagement.File.FileIO

参数:

参数名类型必填说明
uristring本地文件uri,如果文件不存在会创建文件。
bufferUint8Array写入的Buffer。
positionnumber文件开始写入数据的位置的偏移量,默认为0。
appendboolean是否追加模式,默认为false。当设置为true时,position参数无效。
successFunction接口调用成功的回调函数。
failFunction接口调用失败的回调函数。
completeFunction接口调用结束的回调函数。

fail返回错误代码:

错误码说明
202出现参数错误。
300出现I/O错误。

示例:

export default {    
  writeArrayBuffer() {       
    file.writeArrayBuffer({           
      uri: 'internal://app/test',           
      buffer: new Uint8Array(8), //buffer为Uint8Array类型           
      success: function() {                
        console.log('call writeArrayBuffer success.');            
      },           
      fail: function(data, code) {                
        console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
      },
    });    
  }
}

file.readText

readText(Object): void

从指定文件中读取文本内容。仅支持文本文档读写。

系统能力: SystemCapability.FileManagement.File.FileIO

参数:

参数名类型必填说明
uristring本地文件uri。
encodingstring编码格式,缺省为UTF-8。
positionnumber读取的起始位置,默认值为文件的起始位置。
lengthnumber读取的长度,默认值为4096。
successFunction接口调用成功的回调函数。
failFunction接口调用失败的回调函数。
completeFunction接口调用结束的回调函数。

success返回值:

参数名类型说明
textstring读取到的文本内容。

fail返回错误代码:

错误码说明
202出现参数错误。
300出现I/O错误。
301文件或目录不存在。
302要读取的文件内容超过4KB。

示例:

export default {    
  readText() {        
    file.readText({            
      uri: 'internal://app/text.txt',            
      success: function(data) {                
        console.log('call readText success: ' + data.text);            
      },            
      fail: function(data, code) {                
        console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
      },        
    });    
  }
}

file.readArrayBuffer

readArrayBuffer(Object): void

从指定文件中读取Buffer内容。仅支持文本文档读写。

系统能力: SystemCapability.FileManagement.File.FileIO

参数:

参数名类型必填说明
uristring本地文件uri。
positionnumber读取的起始位置,缺省为文件的起始位置。
lengthnumber需要读取的长度,缺省则读取到文件结尾。
successFunction接口调用成功的回调函数。
failFunction接口调用失败的回调函数。
completeFunction接口调用结束的回调函数。

success返回值:

参数名类型说明
bufferUint8Array读取到的文件内容。

fail返回错误代码:

错误码说明
202出现参数错误。
300出现I/O错误。
301文件或目录不存在。

示例:

export default {    
  readArrayBuffer() {        
    file.readArrayBuffer({            
      uri: 'internal://app/test',            
      position: 10,            
      length: 200,            
      success: function(data) {                
        console.log('call readArrayBuffer success: ' + data.buffer);            
      },            
      fail: function(data, code) {                
        console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
      },
    });    
  }
}

file.access

access(Object): void

判断指定文件或目录是否存在。

系统能力: SystemCapability.FileManagement.File.FileIO

参数:

参数名类型必填说明
uristring目录或文件uri。
successFunction接口调用成功的回调函数。
failFunction接口调用失败的回调函数。
completeFunction接口调用结束的回调函数。

fail返回错误代码:

错误码说明
202出现参数错误。
300出现I/O 错误。
301文件或目录不存在。

示例:

export default {    
  access() {        
    file.access({            
      uri: 'internal://app/test',            
      success: function() {                
        console.log('call access success.');            
      },            
      fail: function(data, code) {                
        console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
      },        
    });    
  }
}

file.mkdir

mkdir(Object): void

创建指定目录。

系统能力: SystemCapability.FileManagement.File.FileIO

参数:

参数名类型必填说明
uristring目录的uri路径。
recursiveboolean是否递归创建该目录的上级目录,缺省为false。
successFunction接口调用成功的回调函数。
failFunction接口调用失败的回调函数。
completeFunction接口调用结束的回调函数。

fail返回错误代码:

错误码说明
202出现参数错误。
300出现I/O 错误。

示例:

export default {    
  mkdir() {        
    file.mkdir({            
      uri: 'internal://app/test_directory',            
      success: function() {                
        console.log('call mkdir success.');            
      },            
      fail: function(data, code) {                
        console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
      },
    });    
  }
}

file.rmdir

rmdir(Object): void

删除指定目录。

系统能力: SystemCapability.FileManagement.File.FileIO

参数:

参数名类型必填说明
uristring目录的uri路径。
recursiveboolean是否递归删除子文件和子目录,缺省为false。
successFunction接口调用成功的回调函数。
failFunction接口调用失败的回调函数。
completeFunction接口调用结束的回调函数。

fail返回错误代码:

错误码说明
202出现参数错误。
300出现I/O 错误。
301文件或目录不存在。HarmonyOS与OpenHarmony鸿蒙文档籽料:结尾扫直接拿

在这里插入图片描述

示例:

export default {    
  rmdir() {        
    file.rmdir({            
      uri: 'internal://app/test_directory',            
      success: function() {                
        console.log('call rmdir success.');            
      },            
      fail: function(data, code) {                
        console.error('call fail callback fail, code: ' + code + ', data: ' + data);            
      },
    });    
  }
}

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1931644.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

OpenCV下的单目标定,双目标定与立体校正(calibrateCamera, stereoCalibrate and stereoRectify)

OpenCV下的单目标定&#xff0c;双目标定与立体校正(calibrateCamera, stereoCalibrate and stereoRectify) 文章目录 1. 杂话2. 单目标定2.1 先看代码2.2 一点解释2.3 calibrateCamera参数 3. 双目标定3.1 先看代码3.2 stereoCalibrate参数 4. 立体校正4.1 先看代码4.2 一点解…

U盘RAW状态深度解析与高效恢复策略

一、U盘RAW状态探秘&#xff1a;数据访问的隐形壁垒 在数字化时代&#xff0c;U盘作为我们日常生活中不可或缺的数据存储工具&#xff0c;承载着大量的重要信息与文件。然而&#xff0c;当U盘突然变为RAW格式时&#xff0c;这些宝贵的数据便仿佛被无形的屏障所隔离&#xff0c…

前端面试题(CSS篇八)

一、letter-spacing 与字符间距&#xff1f; letter-spacing可以用来控制字符之间的间距&#xff0c;这里说的“字符”包括英文字母、汉字以及空格等。 letter-spacing具有以下一些特性。 &#xff08;1&#xff09;继承性。 &#xff08;2&#xff09;默认值是normal而不是0。…

Go语言中GC(垃圾回收回收机制)三色标记与混合写屏障

5、Golang三色标记混合写屏障GC模式全分析 (yuque.com) 第1讲-课程目标_哔哩哔哩_bilibili Golang三色标记GC混合写屏障 Go V1.3之前的标记清除&#xff08;mark and sweep) 垃圾回收、内存管理、自动适放、三色标记法、STW (stop the world) 图的遍历&#xff1f;可达性分…

轴端命名 及多器件编号

1.轴端命名 轴如果单端动力输入时&#xff0c;动力输入一侧&#xff0c;可以称为&#xff1a; 输入端&#xff0c;驱动端 另一侧可能的称谓是&#xff1a; 支撑端、自由端、从动端、未驱动端、静态支撑端。 另外&#xff0c;在查阅相关称谓时&#xff0c;看到了关于卷扬机…

<Rust>egui部件学习:如何在窗口及部件显示中文字符?

前言 本专栏是关于Rust的GUI库egui的部件讲解及应用实例分析&#xff0c;主要讲解egui的源代码、部件属性、如何应用。 环境配置 系统&#xff1a;windows 平台&#xff1a;visual studio code 语言&#xff1a;rust 库&#xff1a;egui、eframe 概述 本文是本专栏的第一篇博…

简约唯美的404HTML源码

源码介绍 简约唯美的404HTML源码,很适合做网站错误页,将下面的源码放到一个空白的html里面,然后上传到服务器里面即可使用 效果预览 完整源码 <!DOCTYPE html> <html><head><meta charset="utf-8"><title>404 Error Example<…

配置服务器

参考博客 1. https://blog.csdn.net/qq_31278903/article/details/83146031 2. https://blog.csdn.net/u014374826/article/details/134093409 3. https://blog.csdn.net/weixin_42728126/article/details/88887350 4. https://blog.csdn.net/Dreamhai/article/details/109…

Linux主机添加ipv6地址

一、添加网卡ipv6地址 通过命令行添加 ip add add 2001:db8:0:1::102/64 dev ens160 通过编辑/etc/sysconfig/network-scripts/目录下的ifcfg-配置文件添加 TYPEEthernet BOOTPROTOdhcp # 或者指定为 "static" 如果你想要静态配置 DEFROUTEyes IPV4_FAILURE_FAT…

多元统计分析概述

目录 1. 多元回归分析 2. 主成分分析&#xff08;PCA&#xff09; 3. 因子分析 4. 判别分析 5. 聚类分析 6. 多维尺度分析&#xff08;MDS&#xff09; 结论 多元统计分析是一组用于分析多个变量之间关系的统计方法。它广泛应用于各个领域&#xff0c;如市场研究、生物医…

C++中的语句详细介绍:简单语句、条件、循环迭代语句、跳转语句、异常处理语句、try语句等

文章目录 C中的语句(1)简单语句A.空语句B.复合语句 (2)条件语句(3)迭代语句A.常规for循环B.范围for循环C.while和do...while (4)跳转语句A.break语句B.continue语句C.goto语句 (5)异常处理语句A.标准异常B.throw抛出异常 (6)try语句 C中的语句 (1)简单语句 简单语句包括&#…

探索 Python 的宝藏:深入理解 NumPy库

探索 Python 的宝藏&#xff1a;深入理解 NumPy 库 引言&#xff1a;为何选择 NumPy&#xff1f; NumPy 是 Python 中一个基础而强大的库&#xff0c;它为 Python 语言提供了高性能的多维数组对象和相应的操作。在科学计算、数据分析、机器学习等领域&#xff0c;NumPy 以其高…

Android获取当前屏幕显示的是哪个activity

在 Android 中&#xff0c;要获取当前屏幕显示的 Activity&#xff0c;可以使用以下几种方法&#xff1a; 方法一&#xff1a;使用 ActivityManager 获取当前运行的任务信息 这是一个常见的方法&#xff0c;尽管从 Android 5.0 (API 21) 开始&#xff0c;有些方法变得不太可靠…

ctfshow~VIP限免题目20道(保姆级解析)

奈何自己没有实力&#xff0c;看到免费的东西就想占点便宜&#xff0c;想着做都做了就出个wp吧&#xff0c;本人小白&#xff0c;不喜勿喷&#xff01; 一、源码泄露 题目提示&#xff1a;开发注释未及时删除 题目给出了源码泄露&#xff0c;那咱直接看源码&#xff08;右键点…

2.I/O口

文章目录 I/O输出(点灯)分析电路代码编写 I/O输入(电平检测)代码编写 I/O内部电路分析51单片机STM32单片机输入输出 I/O输出(点灯) 分析电路 看电路图&#xff0c;元器件形成电压差&#xff0c;即可点亮LED灯 代码编写 使用不同操作进行LED控制 #include "reg52.h&quo…

AI助手在企业虚拟展厅中的应用有哪些?

在AI人工智能发展的浪潮下&#xff0c;视创云展也在元宇宙展厅中创新的融入了「AI智能助手」&#xff0c;当用户在虚拟展厅内自由探索时&#xff0c;AI智能助手始终如影随形&#xff0c;为用户提供即时、精准的信息解答与互动体验&#xff0c;使参观过程更加智能化、便捷化和个…

吴恩达机器学习笔记 三十八 二进制标签 均值归一化

标签 0 和 1 可以有很多种意义。从回归到二分分类&#xff1a;之前定义 ,而对于二进制标签&#xff0c;通过给出y^(i,j)为 1 的概率&#xff0c;其中 损失函数 均值归一化 计算每个电影的平均得分&#xff0c;例如第一部电影的平均分为2.5&#xff0c;第五部电影的平均分为1.2…

HP iLO5服务器硬件监控指标解读

在现代化数据中心中&#xff0c;服务器的稳定运行对于保障业务的连续性至关重要。HP的iLO&#xff08;Integrated Lights-Out&#xff09;技术&#xff0c;尤其是iLO5版本&#xff0c;为HP服务器提供了强大的远程管理功能。监控易作为一款专业的监控软件&#xff0c;通过支持HP…

Artix7系列FPGA实现SDI视频编解码,基于GTP高速接口,提供3套工程源码和技术支持

目录 1、前言工程概述免责声明 2、相关方案推荐本博已有的 SDI 编解码方案本方案在Xilinx--Kintex系列FPGA上的应用本方案在Xilinx--Zynq系列FPGA上的应用 3、详细设计方案设计原理框图SDI 输入设备Gv8601a 均衡器GTP 高速接口-->解串与串化SMPTE SD/HD/3G SDI IP核BT1120转…

【爬虫】滑块缺口识别

滑块示例 分为背景图 和 滑块图 主要目的 识别背景图滑块缺口 下载识别库 pip install opencvcode import numpy as np import cv2def identify_gap(bg, tp):bg1 np.asarray(bytearray(bg), dtypenp.uint8)tp1 np.asarray(bytearray(tp), dtypenp.uint8)# 灰度bg_img cv2…