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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gfs_unlink</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
<a name="gfs-unlink.3"></a><div class="titlepage"></div>
<div class="refnamediv">
<a name="name"></a><h2>Name</h2>
<p>gfs_unlink — delete a file</p>
</div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<div class="funcsynopsis">
<pre class="funcsynopsisinfo">
#include <gfarm/gfarm.h>
</pre>
<table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr>
<td><code class="funcdef"><b class="fsfunc">gfarm_error_t gfs_unlink</b>(</code></td>
<td>
<var class="pdparam">gfarm_url</var><code>)</code>;</td>
<td> </td>
</tr></table>
<div class="paramdef-list">
<code>const char * <var class="pdparam">gfarm_url</var></code>;</div>
<div class="funcprototype-spacer"> </div>
</div>
</div>
<div class="refsect1">
<a name="description"></a><h2>DESCRIPTION</h2>
<p><code class="function">gfs_unlink()</code> deletes the file whose name is the string specified
by <em class="parameter"><code>gfarm_url</code></em>.</p>
</div>
<div class="refsect1">
<a name="return-values"></a><h2>RETURN VALUES</h2>
<div class="variablelist"><dl class="variablelist">
<dt><span class="term"><code class="constant">GFARM_ERR_NO_ERROR</code></span></dt>
<dd><p>The function terminated successfully.</p></dd>
<dt><span class="term"><code class="constant">GFARM_ERR_NO_MEMORY</code></span></dt>
<dd><p>Insufficient memory was available.</p></dd>
<dt><span class="term"><code class="constant">GFARM_ERR_AUTHENTICATION</code></span></dt>
<dd><p>User authentication failed when connecting to gfmd(8).</p></dd>
<dt><span class="term"><code class="constant">GFARM_ERR_PERMISSION_DENIED</code></span></dt>
<dd><p><em class="parameter"><code>gfarm_url</code></em>
points outside your accessible address space.</p></dd>
<dt><span class="term"><code class="constant">GFARM_ERR_NO_SUCH_OBJECT</code></span></dt>
<dd><p><em class="parameter"><code>gfarm_url</code></em> does not exist.</p></dd>
<dt><span class="term"><code class="constant">GFARM_ERR_NOT_A_DIRECTORY</code></span></dt>
<dd><p>A component of the path prefix is not a directory.</p></dd>
<dt><span class="term">Others</span></dt>
<dd><p>An error except the above occurred. The reason is shown by
<span class="citerefentry"><span class="refentrytitle">gfarm_error_string</span>(3)</span>.</p></dd>
</dl></div>
</div>
</div></body>
</html>
|
