<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.socket-addrinfo-lookup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>socket_addrinfo_lookup</refname>
  <refpurpose>Get array with contents of getaddrinfo about the given hostname</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>socket_addrinfo_lookup</methodname>
   <methodparam><type>string</type><parameter>host</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>service</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>hints</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
  <para>
   Lookup different ways we can connect to <parameter>host</parameter>.  The returned array contains
   a set of <classname>AddressInfo</classname> instances that we can bind to using <function>socket_addrinfo_bind</function>.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>host</parameter></term>
    <listitem>
     <para>
      Hostname to search.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>service</parameter></term>
    <listitem>
     <para>
      The service to connect to. If service is a numeric string, it designates the port.
      Otherwise it designates a network service name, which is mapped to a port by the operating system.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>hints</parameter></term>
    <listitem>
     <para>
      Hints provide criteria for selecting addresses returned.  You may specify the
      hints as defined by getaddrinfo.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array of <classname>AddressInfo</classname> instances that can be used with the other socket_addrinfo functions.
   On failure, &false; is returned.
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <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 array of <classname>AddressInfo</classname> instances now;
       previously, an array of <type>resource</type>s was returned.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>service</parameter> is nullable now.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>socket_addrinfo_bind</function></member>
    <member><function>socket_addrinfo_connect</function></member>
    <member><function>socket_addrinfo_explain</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
-->
