Files
doc-fr/reference/info/functions/cli-set-process-title.xml
2023-11-04 14:52:02 +00:00

114 lines
2.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 2df224f44552cfc88fad705cca33c4cdb01d62ed Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.cli-set-process-title" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>cli_set_process_title</refname>
<refpurpose>Définit le titre du processus</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>cli_set_process_title</methodname>
<methodparam><type>string</type><parameter>title</parameter></methodparam>
</methodsynopsis>
<para>
Définit le titre du processus visible avec des outils comme
<command>top</command> et <command>ps</command>. Cette fonction
n'est disponible qu'en mode
<link linkend="features.commandline">CLI</link>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>title</parameter></term>
<listitem>
<para>
Le nouveau titre
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Une alerte de niveau <constant>E_WARNING</constant> sera générée si le système
sous-jacent n'est pas supporté.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>cli_set_process_title</function></title>
<programlisting role="php">
<![CDATA[
<?php
$title = "Mon super script PHP";
$pid = getmypid(); // vous pouvez utiliser ceci pour voir le titre de votre processus dans ps
if (!cli_set_process_title($title)) {
echo "Impossible de définir le titre du processus pour le PID $pid...\n";
exit(1);
} else {
echo "Le titre du processus '$title' pour le PID $pid a bien été défini !\n";
sleep(5);
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>cli_get_process_title</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
-->