This page is Out of Date

Notice: The WebPlatform project, supported by various stewards between 2012 and 2015, has been discontinued. This site is now available on github.

getFile

Summary

Creates or looks up a file.

Out of date; feature discontinued. See http://www.w3.org/TR/file-system-api.

Method of apis/filesystem/DirectoryEntrySyncapis/filesystem/DirectoryEntrySync

Syntax

var  = DirectoryEntrySync.getFile(path, options);

Parameters

path

Data-type
String

Either an absolute path or a relative path from this DirectoryEntrySync to the file to be looked up or created. It is an error to attempt to create a file whose immediate parent does not yet exist.

options

Data-type
String

(Optional)

  • If create and exclusive are both true and the path already exists, getFile must fail.
  • If create is true, the path doesn’t exist, and no other error occurs, getFile must create it as a zero-length file and return a corresponding FileEntry.
  • If create is not true and the path doesn’t exist, getFile must fail.
  • If create is not true and the path exists, but is a directory, getFile must fail.
  • Otherwise, if no other error occurs, getFile must return a FileEntrySync corresponding to path.

Return Value

Returns an object of type

FileEntrySync

Related specifications

W3C File API: Directories and System Specification
W3C Working Draft