Source of: /manual/en/function.hwapi-hgcsp.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.hwapi.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.hwapi-hgcsp.php',
1 => 'hwapi_hgcsp',
),
'up' =>
array (
0 => 'ref.hwapi.php',
1 => 'Hyperwave API Functions',
),
'prev' =>
array (
0 => 'function.hwapi-ftstat.php',
1 => 'hw_api->ftstat',
),
'next' =>
array (
0 => 'function.hwapi-hwstat.php',
1 => 'hw_api->hwstat',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.hwapi-hgcsp" class="refentry">
<div class="refnamediv">
<h1 class="refname">hwapi_hgcsp</h1>
<p class="verinfo">(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hwapi_hgcsp</span> — <span class="dc-title">Returns object of class hw_api</span></p>
</div>
<a name="function.hwapi-hgcsp.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type HW_API">HW_API</span></span> <span class="methodname"><b>hwapi_hgcsp</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$hostname</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$port</tt></span>
] )</div>
<p class="para rdfs-comment">
Opens a connection to the Hyperwave server on host
<i><tt class="parameter">hostname</tt></i>
. The protocol used is HGCSP.
</p>
</div>
<a name="function.hwapi-hgcsp.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">hostname</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The host name.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">port</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
If you do not pass a port number, 418 is used.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.hwapi-hgcsp.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an instance of <b class="classname">HW_API</b>.
</p>
</div>
</div><?php manual_footer(); ?>
