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