文件存儲

說明：
開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

• 從API Version 6開始，該接口不再維護，推薦使用新接口[@ohos.fileio]。
• 本模塊首批接口從API version 3開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。

導入模塊

import file from '@system.file';

file.move

move(Object): void

將指定文件移動到其他指定位置。

系統能力： SystemCapability.FileManagement.File.FileIO

參數：

fail返回錯誤代碼：

示例：

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

參數：

fail返回錯誤代碼：

示例：

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

參數：

success返回值：

表1 FileInfo

fail返回錯誤代碼：

示例：

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

參數：

success返回值：

fail返回錯誤代碼：

示例：

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

參數：

fail返回錯誤代碼：

示例：

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

參數：

fail返回錯誤代碼：

示例：

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

參數：

fail返回錯誤代碼：

示例：

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

參數：

success返回值：

fail返回錯誤代碼：

示例：

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

參數：

success返回值：

fail返回錯誤代碼：

示例：

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

參數：

fail返回錯誤代碼：

示例：

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

參數：

fail返回錯誤代碼：

示例：

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

參數：

fail返回錯誤代碼：

示例：

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);            
      },
    });    
  }
}

審核編輯 黃宇