@system.file (File Storage)

NOTE - The APIs provided by this module are no longer maintained since API Version 10. You are advised to use @ohos.file.fs.

• The initial APIs of this module are supported since API version 3. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import file from '@system.file';

file.move

move(Object): void

Moves a specified file to a given location.

NOTE

This API is deprecated since API version 10. Use fs.moveFile instead.

System Capability: SystemCapability.FileManagement.File.FileIO.Lite

Parameters

Error codes

Example

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

Copies a file to the given URI.

NOTE

This API is deprecated since API version 10. Use fs.copyFile instead.

System Capability: SystemCapability.FileManagement.File.FileIO.Lite

Parameters

Error codes

Example

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

Obtains all files in the specified directory.

NOTE

This API is deprecated since API version 10. Use fs.listFile instead.

System Capability: SystemCapability.FileManagement.File.FileIO.Lite

Parameters

Return value of success()

Table 1 FileInfo

Error codes

Example

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

Obtains information about a local file.

NOTE

This API is deprecated since API version 10. Use fs.stat instead.

System Capability: SystemCapability.FileManagement.File.FileIO.Lite

Parameters

Return value of success()

Error codes

Example

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

Deletes a local file.

NOTE

This API is deprecated since API version 10. Use fs.unlink instead.

System Capability: SystemCapability.FileManagement.File.FileIO.Lite

Parameters

Error codes

Example

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

Writes text into a file. Only text files can be read and written.

NOTE

This API is deprecated since API version 10. Use fs.write instead.

System Capability: SystemCapability.FileManagement.File.FileIO.Lite

Parameters

Error codes

Example

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

Writes buffer data into a file. Only text files can be read and written.

NOTE

This API is deprecated since API version 10. Use fs.write instead.

System Capability: SystemCapability.FileManagement.File.FileIO.Lite

Parameters

Error codes

Example

export default {    
  writeArrayBuffer() {       
    file.writeArrayBuffer({           
      uri: 'internal://app/test',           
      buffer: new Uint8Array(8), // The buffer is of the Uint8Array type.          
      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

Reads text from a file. Only text files can be read and written.

NOTE

This API is deprecated since API version 10. Use fs.readText instead.

System Capability: SystemCapability.FileManagement.File.FileIO.Lite

Parameters

Return value of success()

Error codes

Example

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

Reads buffer data from a file. Only text files can be read and written.

NOTE

This API is deprecated since API version 10. Use fs.read instead.

System Capability: SystemCapability.FileManagement.File.FileIO.Lite

Parameters

Return value of success()

Error codes

Example

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

Checks whether a file or directory exists.

NOTE

This API is deprecated since API version 10. Use fs.access instead.

System Capability: SystemCapability.FileManagement.File.FileIO.Lite

Parameters

Error codes

Example

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

Creates a directory.

NOTE

This API is deprecated since API version 10. Use fs.mkdir instead.

System Capability: SystemCapability.FileManagement.File.FileIO.Lite

Parameters

Error codes

Example

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

Deletes a directory.

NOTE

This API is deprecated since API version 10. Use fs.rmdir instead.

System Capability: SystemCapability.FileManagement.File.FileIO.Lite

Parameters

Error codes

Example

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

你可能感兴趣的鸿蒙文章

harmony 鸿蒙APIs

harmony 鸿蒙System Common Events (To Be Deprecated Soon)

harmony 鸿蒙System Common Events

harmony 鸿蒙API Reference Document Description

harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)

harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)

harmony 鸿蒙@ohos.bundle (Bundle)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)