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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gfs_acl_to_any_text</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="gfs_acl_to_any_text">
<a name="gfs-acl-to-any-text.3"></a><div class="titlepage"></div>
<div class="refnamediv">
<a name="name"></a><h2>Name</h2>
<p>gfs_acl_to_any_text — convert a Gfarm ACL to text</p>
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="synopsis"></a><h2>Synopsis</h2>
<div class="funcsynopsis">
<pre class="funcsynopsisinfo">
#include <gfarm/gfarm.h>
</pre>
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td><code class="funcdef"><b class="fsfunc">gfarm_error_t gfs_acl_to_any_text</b>(</code></td>
<td>
<var class="pdparam">acl</var>, </td>
<td> </td>
</tr>
<tr>
<td> </td>
<td>
<var class="pdparam">prefix</var>, </td>
<td> </td>
</tr>
<tr>
<td> </td>
<td>
<var class="pdparam">separator</var>, </td>
<td> </td>
</tr>
<tr>
<td> </td>
<td>
<var class="pdparam">options</var>, </td>
<td> </td>
</tr>
<tr>
<td> </td>
<td>
<var class="pdparam">str_p</var><code>)</code>;</td>
<td> </td>
</tr>
</table>
<div class="paramdef-list">
<code>gfarm_acl_t <var class="pdparam">acl</var></code>;<br><code>const char *<var class="pdparam">prefix</var></code>;<br><code>char <var class="pdparam">separator</var></code>;<br><code>int <var class="pdparam">options</var></code>;<br><code>char **<var class="pdparam">str_p</var></code>;</div>
<div class="funcprototype-spacer"> </div>
</div>
</div>
<div class="refsect1" title="INPUT ARGUMENTS">
<a name="input-arguments"></a><h2>INPUT ARGUMENTS</h2>
<div class="variablelist"><dl>
<dt><span class="term"><em class="parameter"><code>acl</code></em></span></dt>
<dd><p>An ACL structure type.</p></dd>
<dt><span class="term"><em class="parameter"><code>prefix</code></em></span></dt>
<dd><p>If the argument <em class="parameter"><code>prefix</code></em> is not NULL, each
entry can have this character string.</p></dd>
<dt><span class="term"><em class="parameter"><code>separator</code></em></span></dt>
<dd><p>ACL entries are separeted by
this <em class="parameter"><code>separator</code></em> character.</p></dd>
<dt><span class="term"><em class="parameter"><code>options</code></em></span></dt>
<dd><p>Bitwise combinations of the following OPTIONS section.</p></dd>
<dt><span class="term"><em class="parameter"><code>str_p</code></em></span></dt>
<dd><p>A pointer to the long text form string of the ACL.</p></dd>
</dl></div>
</div>
<div class="refsect1" title="OPTIONS">
<a name="options"></a><h2>OPTIONS</h2>
<div class="variablelist"><dl>
<dt><span class="term"><em class="parameter"><code>GFARM_ACL_TEXT_ABBREVIATE</code></em></span></dt>
<dd><p>Instead of the full tag type keywords, single letter
abbreviations are used.</p></dd>
<dt><span class="term"><em class="parameter"><code>GFARM_ACL_TEXT_SOME_EFFECTIVE</code></em></span></dt>
<dd><p>A comment containing the effective permissions in some ACL
entries.</p></dd>
<dt><span class="term"><em class="parameter"><code>GFARM_ACL_TEXT_ALL_EFFECTIVE</code></em></span></dt>
<dd><p>A comment containing the effective permissions in all ACL entries.</p></dd>
<dt><span class="term"><em class="parameter"><code>GFARM_ACL_TEXT_SMART_INDENT</code></em></span></dt>
<dd><p>If this option is used with the GFARM_ACL_TEXT_SOME_EFFECTIVE or
GFARM_ACL_TEXT_ALL_EFFECTIVE option, the effective comment is aligned
to column 40.</p></dd>
</dl></div>
</div>
<div class="refsect1" title="RETURN VALUES">
<a name="return-values"></a><h2>RETURN VALUES</h2>
<div class="variablelist"><dl>
<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">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 class="refsect1" title="SEE ALSO">
<a name="see-also"></a><h2>SEE ALSO</h2>
<p>
<span class="citerefentry"><span class="refentrytitle">gfs_acl_free</span>(3)</span>,
<span class="citerefentry"><span class="refentrytitle">gfs_acl_to_text</span>(3)</span>,
<span class="citerefentry"><span class="refentrytitle">gfs_acl_from_text</span>(3)</span>
</p>
</div>
</div></body>
</html>
|
