php-doc-en/reference/posix/functions/posix-setrlimit.xml

99 lines
2.5 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.posix-setrlimit" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>posix_setrlimit</refname>
<refpurpose>Set system resource limits</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>posix_setrlimit</methodname>
<methodparam><type>int</type><parameter>resource</parameter></methodparam>
<methodparam><type>int</type><parameter>softlimit</parameter></methodparam>
<methodparam><type>int</type><parameter>hardlimit</parameter></methodparam>
</methodsynopsis>
<para>
<function>posix_setrlimit</function> sets the soft and hard limits for a
given system resource.
</para>
&posix.rlimits;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>resource</parameter></term>
<listitem>
<para>
The
<link linkend="posix.constants.setrlimit">resource limit constant</link>
corresponding to the limit that is being set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>softlimit</parameter></term>
<listitem>
<para>
The soft limit, in whatever unit the resource limit requires, or
<constant>POSIX_RLIMIT_INFINITY</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>hardlimit</parameter></term>
<listitem>
<para>
The hard limit, in whatever unit the resource limit requires, or
<constant>POSIX_RLIMIT_INFINITY</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>man page SETRLIMIT(2)</member>
<member><function>posix_getrlimit</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->