xref: /third_party/FatFs/documents/doc/chmod.html (revision e6865dcd)
1e6865dcdSopenharmony_ci<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2e6865dcdSopenharmony_ci<html lang="en">
3e6865dcdSopenharmony_ci<head>
4e6865dcdSopenharmony_ci<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5e6865dcdSopenharmony_ci<meta http-equiv="Content-Style-Type" content="text/css">
6e6865dcdSopenharmony_ci<link rel="up" title="FatFs" href="../00index_e.html">
7e6865dcdSopenharmony_ci<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/chmod.html">
8e6865dcdSopenharmony_ci<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
9e6865dcdSopenharmony_ci<title>FatFs - f_chmod</title>
10e6865dcdSopenharmony_ci</head>
11e6865dcdSopenharmony_ci
12e6865dcdSopenharmony_ci<body>
13e6865dcdSopenharmony_ci
14e6865dcdSopenharmony_ci<div class="para func">
15e6865dcdSopenharmony_ci<h2>f_chmod</h2>
16e6865dcdSopenharmony_ci<p>The f_chmod function changes the attribute of a file or sub-directory.</p>
17e6865dcdSopenharmony_ci<pre>
18e6865dcdSopenharmony_ciFRESULT f_chmod (
19e6865dcdSopenharmony_ci  const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] Object name */</span>
20e6865dcdSopenharmony_ci  BYTE <span class="arg">attr</span>,         <span class="c">/* [IN] Attribute flags */</span>
21e6865dcdSopenharmony_ci  BYTE <span class="arg">mask</span>          <span class="c">/* [IN] Attribute masks */</span>
22e6865dcdSopenharmony_ci);
23e6865dcdSopenharmony_ci</pre>
24e6865dcdSopenharmony_ci</div>
25e6865dcdSopenharmony_ci
26e6865dcdSopenharmony_ci<div class="para arg">
27e6865dcdSopenharmony_ci<h4>Parameters</h4>
28e6865dcdSopenharmony_ci<dl class="par">
29e6865dcdSopenharmony_ci<dt>path</dt>
30e6865dcdSopenharmony_ci<dd>Pointer to the null-terminated string that specifies an <a href="filename.html">object</a> to be changed</dd>
31e6865dcdSopenharmony_ci<dt>attr</dt>
32e6865dcdSopenharmony_ci<dd>Attribute flags to be set in one or more combination of the following flags. The specified flags are set and others are cleard.<br>
33e6865dcdSopenharmony_ci<table class="lst">
34e6865dcdSopenharmony_ci<tr><th>Attribute</th><th>Description</th></tr>
35e6865dcdSopenharmony_ci<tr><td>AM_RDO</td><td>Read only</td></tr>
36e6865dcdSopenharmony_ci<tr><td>AM_ARC</td><td>Archive</td></tr>
37e6865dcdSopenharmony_ci<tr><td>AM_SYS</td><td>System</td></tr>
38e6865dcdSopenharmony_ci<tr><td>AM_HID</td><td>Hidden</td></tr>
39e6865dcdSopenharmony_ci</table>
40e6865dcdSopenharmony_ci</dd>
41e6865dcdSopenharmony_ci<dt>mask</dt>
42e6865dcdSopenharmony_ci<dd>Attribute mask that specifies which attribute is changed. The specified attributes are set or cleard and others are left unchanged.</dd>
43e6865dcdSopenharmony_ci</dl>
44e6865dcdSopenharmony_ci</div>
45e6865dcdSopenharmony_ci
46e6865dcdSopenharmony_ci
47e6865dcdSopenharmony_ci<div class="para ret">
48e6865dcdSopenharmony_ci<h4>Return Values</h4>
49e6865dcdSopenharmony_ci<p>
50e6865dcdSopenharmony_ci<a href="rc.html#ok">FR_OK</a>,
51e6865dcdSopenharmony_ci<a href="rc.html#de">FR_DISK_ERR</a>,
52e6865dcdSopenharmony_ci<a href="rc.html#ie">FR_INT_ERR</a>,
53e6865dcdSopenharmony_ci<a href="rc.html#nr">FR_NOT_READY</a>,
54e6865dcdSopenharmony_ci<a href="rc.html#ok">FR_NO_FILE</a>,
55e6865dcdSopenharmony_ci<a href="rc.html#np">FR_NO_PATH</a>,
56e6865dcdSopenharmony_ci<a href="rc.html#in">FR_INVALID_NAME</a>,
57e6865dcdSopenharmony_ci<a href="rc.html#wp">FR_WRITE_PROTECTED</a>,
58e6865dcdSopenharmony_ci<a href="rc.html#id">FR_INVALID_DRIVE</a>,
59e6865dcdSopenharmony_ci<a href="rc.html#ne">FR_NOT_ENABLED</a>,
60e6865dcdSopenharmony_ci<a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
61e6865dcdSopenharmony_ci<a href="rc.html#tm">FR_TIMEOUT</a>,
62e6865dcdSopenharmony_ci<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
63e6865dcdSopenharmony_ci</p>
64e6865dcdSopenharmony_ci</div>
65e6865dcdSopenharmony_ci
66e6865dcdSopenharmony_ci
67e6865dcdSopenharmony_ci<div class="para desc">
68e6865dcdSopenharmony_ci<h4>Description</h4>
69e6865dcdSopenharmony_ci<p>The <tt>f_chmod</tt> function changes the attribute of a file or sub-directory.</p>
70e6865dcdSopenharmony_ci</div>
71e6865dcdSopenharmony_ci
72e6865dcdSopenharmony_ci
73e6865dcdSopenharmony_ci<div class="para comp">
74e6865dcdSopenharmony_ci<h4>QuickInfo</h4>
75e6865dcdSopenharmony_ci<p>Available when <tt><a href="config.html#fs_readonly">FF_FS_READONLY</a> == 0</tt> and <tt><a href="config.html#use_chmod">FF_USE_CHMOD</a> == 1</tt>.</p>
76e6865dcdSopenharmony_ci</div>
77e6865dcdSopenharmony_ci
78e6865dcdSopenharmony_ci
79e6865dcdSopenharmony_ci<div class="para use">
80e6865dcdSopenharmony_ci<h4>Example</h4>
81e6865dcdSopenharmony_ci<pre>
82e6865dcdSopenharmony_ci    <span class="c">/* Set Read-only, clear Archive and others are left unchanged. */</span>
83e6865dcdSopenharmony_ci    <em>f_chmod</em>("file.txt", AM_RDO, AM_RDO | AM_ARC);
84e6865dcdSopenharmony_ci</pre>
85e6865dcdSopenharmony_ci</div>
86e6865dcdSopenharmony_ci
87e6865dcdSopenharmony_ci<p class="foot"><a href="../00index_e.html">Return</a></p>
88e6865dcdSopenharmony_ci</body>
89e6865dcdSopenharmony_ci</html>
90