<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-fetch-stream">
 <refnamediv>
  <refname>ssh2_fetch_stream</refname>
  <refpurpose>Fetch an extended data stream</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>ssh2_fetch_stream</methodname>
   <methodparam><type>resource</type><parameter>channel</parameter></methodparam>
   <methodparam><type>int</type><parameter>streamid</parameter></methodparam>
  </methodsynopsis>
  <para>
   Fetches an alternate substream associated with an SSH2 channel stream.
   The SSH2 protocol currently defines only one substream, STDERR, which has
   a substream ID of <constant>SSH2_STREAM_STDERR</constant> (defined as 1).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>channel</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>streamid</parameter></term>
     <listitem>
      <para>
       An SSH2 channel stream.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the requested stream resource.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Opening a shell and retrieving the stderr stream associated with it</title>
    <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');

$stdio_stream = ssh2_shell($connection);
$stderr_stream = ssh2_fetch_stream($stdio_stream, SSH2_STREAM_STDERR);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ssh2_shell</function></member>
    <member><function>ssh2_exec</function></member>
    <member><function>ssh2_connect</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
-->