summaryrefslogtreecommitdiff
path: root/lib/stdlib/test/shell_docs_SUITE_data/kernel_file_delete_2_func.txt
blob: d8cc8befc7bbc0b5975306baa965e68bedc5b53e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

  -spec delete(Filename, Opts) -> ok | {error, Reason}
                  when
                      Filename :: name_all(),
                      Opts :: [delete_option()],
                      Reason :: posix() | badarg.

Since:
  OTP 24.0

  Types:
    -type delete_option() :: raw.

  Tries to delete file Filename. Returns ok if successful.

  If the option raw is set, the file server is not called. This
  can be useful in particular during the early boot stage when the
  file server is not yet registered, to still be able to delete
  local files.

  Typical error reasons:

  enoent:
    The file does not exist.

  eacces:
    Missing permission for the file or one of its parents.

  eperm:
    The file is a directory and the user is not superuser.

  enotdir:
    A component of the filename is not a directory. On some
    platforms, enoent is returned instead.

  einval:
    Filename has an improper type, such as tuple.

  Warning:
    In a future release, a bad type for argument Filename will
    probably generate an exception.