php-doc-en/reference/ftp/functions/ftp-connect.xml
Friedhelm Betz fc9c5fe85b bunch of see alsos, some minor typos
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@133602 c90b9560-bf6c-de11-be94-00142212c4b1
2003-06-29 15:05:37 +00:00

81 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-connect">
<refnamediv>
<refname>ftp_connect</refname>
<refpurpose>Opens an FTP connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ftp_connect</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
</methodsynopsis>
<para>
Returns a FTP stream on success or &false; on error.
</para>
<para>
<function>ftp_connect</function> opens an FTP connection to the
specified <parameter>host</parameter>. <parameter>host</parameter>
shouldn't have any trailing slashes and shouldn't be prefixed with
<literal>ftp://</literal>. The <parameter>port</parameter>
parameter specifies an alternate port to connect to. If it is
omitted or set to zero, then the default FTP port, 21, will be used.
</para>
<para>
The <parameter>timeout</parameter> parameter specifies the timeout for all
subsequent network operations. If omitted, the default value is 90
seconds. The timeout can be changed and queried at any time with
<function>ftp_set_option</function> and
<function>ftp_get_option</function>.
<note>
<para>
The <parameter>timeout</parameter> parameter became available in PHP 4.2.0.
</para>
</note>
</para>
<example>
<title><function>ftp_connect</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$ftp_server = "ftp.example.com";
// set up a connection or die
$conn_id = ftp_connect($ftp_server) or die("Couldn't connect to $ftp_server");
?>
]]>
</programlisting>
</example>
<para>
See also <function>ftp_close</function>, and
<function>ftp_ssl_connect</function>.
</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:"../../../../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
-->