reference/posix/functions/posix-getrlimit.xml
9c166423255b3d5e02f74232f2d05fd3b59d5d62
9c166423255b3d5e02f74232f2d05fd3b59d5d62
...
...
@@ -9,8 +9,8 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>array</type><methodname>posix_getrlimit</methodname>
13
-
<void/>
12
+
<type class="union"><type>array</type><type>false</type></type><methodname>posix_getrlimit</methodname>
13
+
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>resource</parameter><initializer>&null;</initializer></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
<function>posix_getrlimit</function> returns an <type>array</type>
...
...
@@ -19,6 +19,23 @@
19
19
&posix.rlimits;
20
20
</refsect1>
21
21
22
+
<refsect1 role="parameters">
23
+
&reftitle.parameters;
24
+
<para>
25
+
<variablelist>
26
+
<varlistentry>
27
+
<term><parameter>resource</parameter></term>
28
+
<listitem>
29
+
<para>
30
+
If &null; all resource limits will be fetched.
31
+
Otherwise, the only limits of the resource type provided will be returned.
32
+
</para>
33
+
</listitem>
34
+
</varlistentry>
35
+
</variablelist>
36
+
</para>
37
+
</refsect1>
38
+
22
39
<refsect1 role="returnvalues">
23
40
&reftitle.returnvalues;
24
41
<para>
...
...
@@ -106,9 +123,32 @@
106
123
</tbody>
107
124
</tgroup>
108
125
</table>
126
+
The function returns &false; on failure.
109
127
</para>
110
128
</refsect1>
111
129
130
+
<refsect1 role="changelog">
131
+
&reftitle.changelog;
132
+
<informaltable>
133
+
<tgroup cols="2">
134
+
<thead>
135
+
<row>
136
+
<entry>&Version;</entry>
137
+
<entry>&Description;</entry>
138
+
</row>
139
+
</thead>
140
+
<tbody>
141
+
<row>
142
+
<entry>8.3.0</entry>
143
+
<entry>
144
+
The optional <parameter>resource</parameter> parameter has been added.
145
+
</entry>
146
+
</row>
147
+
</tbody>
148
+
</tgroup>
149
+
</informaltable>
150
+
</refsect1>
151
+
112
152
<refsect1 role="examples">
113
153
&reftitle.examples;
114
154
<para>
...
...
@@ -167,7 +207,6 @@ Array
167
207
</refsect1>
168
208
169
209
</refentry>
170
-
171
210
<!-- Keep this comment at the end of the file
172
211
Local variables:
173
212
mode: sgml
174
213