socket-wsaprotocol-info-export.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.socket-wsaprotocol-info-export" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>socket_wsaprotocol_info_export</refname>
  <refpurpose>Exports the WSAPROTOCOL_INFO Structure</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>socket_wsaprotocol_info_export</methodname>
   <methodparam><type>Socket</type><parameter>socket</parameter></methodparam>
   <methodparam><type>int</type><parameter>process_id</parameter></methodparam>
  </methodsynopsis>
  <para>
   Exports the <literal>WSAPROTOCOL_INFO</literal> structure into shared memory and returns
   an identifier to be used with <function>socket_wsaprotocol_info_import</function>. The
   exported ID is only valid for the given <parameter>process_id</parameter>.
  </para>
  <note>
   <simpara>
    This function is available only on Windows.
   </simpara>
  </note>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>socket</parameter></term>
    <listitem>
     <para>
      A <classname>Socket</classname> instance.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>process_id</parameter></term>
    <listitem>
     <para>
      The ID of the process which will import the socket.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an identifier to be used for the import, &return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &sockets.changelog.socket-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>socket_wsaprotocol_info_import</function></member>
   <member><function>socket_wsaprotocol_info_release</function></member>
  </simplelist>
 </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
-->