php-doc-en/reference/sem/functions/msg-get-queue.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.msg-get-queue" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>msg_get_queue</refname>
  <refpurpose>Create or attach to a message queue</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>SysvMessageQueue</type><type>false</type></type><methodname>msg_get_queue</methodname>
   <methodparam><type>int</type><parameter>key</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>permissions</parameter><initializer>0666</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>msg_get_queue</function> returns an id that can be used to
   access the System V message queue with the given
   <parameter>key</parameter>. The first call creates the message queue with
   the optional <parameter>permissions</parameter>.
   A second call to <function>msg_get_queue</function> for the same
   <parameter>key</parameter> will return a different message queue
   identifier, but both identifiers access the same underlying message
   queue.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       Message queue numeric ID
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>permissions</parameter></term>
     <listitem>
      <para>
       Queue permissions. Default to 0666. If the message queue already
       exists, the <parameter>permissions</parameter> will be ignored.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns <classname>SysvMessageQueue</classname> instance that can be used to access the System V message queue,
   &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.0.0</entry>
       <entry>
        On success, this function returns a <classname>SysvMessageQueue</classname> instance now;
        previously, a <type>resource</type> was returned.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>msg_remove_queue</function></member>
    <member><function>msg_receive</function></member>
    <member><function>msg_send</function></member>
    <member><function>msg_stat_queue</function></member>
    <member><function>msg_set_queue</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
-->