2002-04-15 00:12:54 +00:00
|
|
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
2007-06-20 22:25:43 +00:00
|
|
|
<!-- $Revision: 1.5 $ -->
|
2002-04-15 00:12:54 +00:00
|
|
|
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
|
2007-06-20 22:25:43 +00:00
|
|
|
<refentry xml:id="function.hw-connect" xmlns="http://docbook.org/ns/docbook">
|
2002-04-15 00:12:54 +00:00
|
|
|
<refnamediv>
|
|
|
|
|
<refname>hw_Connect</refname>
|
2004-08-19 12:14:46 +00:00
|
|
|
<refpurpose>Opens a connection</refpurpose>
|
2002-04-15 00:12:54 +00:00
|
|
|
</refnamediv>
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Description</title>
|
|
|
|
|
<methodsynopsis>
|
|
|
|
|
<type>int</type><methodname>hw_connect</methodname>
|
|
|
|
|
<methodparam><type>string</type><parameter>host</parameter></methodparam>
|
|
|
|
|
<methodparam><type>int</type><parameter>port</parameter></methodparam>
|
2005-06-21 13:56:28 +00:00
|
|
|
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
|
2002-04-15 00:12:54 +00:00
|
|
|
<methodparam><type>string</type><parameter>password</parameter></methodparam>
|
|
|
|
|
</methodsynopsis>
|
|
|
|
|
<para>
|
|
|
|
|
Opens a connection to a Hyperwave server and returns a connection
|
|
|
|
|
index on success, or &false; if the connection
|
|
|
|
|
could not be made. Each of the arguments should be a quoted string,
|
|
|
|
|
except for the port number. The <parameter>username</parameter> and
|
|
|
|
|
<parameter>password</parameter> arguments are
|
|
|
|
|
optional and can be left out. In such a case no identification with
|
|
|
|
|
the server will be done. It is similar to identify as user anonymous.
|
|
|
|
|
This function returns a connection
|
|
|
|
|
index that is needed by other Hyperwave functions. You can have
|
|
|
|
|
multiple connections open at once. Keep in mind, that the password
|
|
|
|
|
is not encrypted.
|
|
|
|
|
</para>
|
|
|
|
|
<para>
|
|
|
|
|
See also <function>hw_pconnect</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
|
|
|
|
|
-->
|
