Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 1f9eb832ba1e4b88d9a5c2b384813bb4 > files > 3070

kdelibs3-apidocs-3.5.10-31.fc15.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">

<head>
  <title>kdesu: PtyProcess Class Reference (kdesu)</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  <meta http-equiv="Content-Style-Type" content="text/css" />

  <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org"  r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org"  r (n 0 s 0 v 0 l 0))' />

  <meta name="trademark" content="KDE e.V." />
  <meta name="description" content="K Desktop Environment Homepage, KDE.org" />
  <meta name="MSSmartTagsPreventParsing" content="true" />
  <meta name="robots" content="all" />

  <link rel="shortcut icon" href="../../favicon.ico" />

<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />



</head>

<body>

<div id="nav_header_top" align="right">
  <a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>

  <a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
  <span class="doNotDisplay">::</span>

  <div id="nav_header_title" align="left">KDE API Reference</div>


</div>

<div id="nav_header_bottom" align="right">
  <span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
  <div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
 / <a href=".">kdesu</a>
  </div>
</div>


<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
      <td valign="top" class="menuheader" height="0"></td>

  <td id="contentcolumn" valign="top" rowspan="2" >
    <div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
    <a name="content"></a>


<!-- Generated by Doxygen 1.7.4 -->
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">PtyProcess Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="PtyProcess" -->
<p>Synchronous communication with tty programs.  
 <a href="classPtyProcess.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="process_8h_source.html">process.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PtyProcess:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classPtyProcess.png" usemap="#PtyProcess_map" alt=""/>
  <map id="PtyProcess_map" name="PtyProcess_map">
<area href="classStubProcess.html" title="Chat with kdesu_stub." alt="StubProcess" shape="rect" coords="46,56,129,80"/>
<area href="classSshProcess.html" title="Executes a remote command, using ssh." alt="SshProcess" shape="rect" coords="0,112,83,136"/>
<area href="classSuProcess.html" title="Executes a command under elevated privileges, using su." alt="SuProcess" shape="rect" coords="93,112,176,136"/>
</map>
 </div></div>

<p><a href="classPtyProcess-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#aae691249f6a0985de8f630e4a898dc85">checkPidStatus</a> { <b>Error</b> = -1, 
<b>NotExited</b> = -2, 
<b>Killed</b> = -3
 }</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#a109647b1399b9815dad3cb67e1bd86e1">exec</a> (const <a class="elRef" href="qcstring.html">QCString</a> &amp;command, const <a class="elRef" href="qvaluelist.html">QCStringList</a> &amp;args)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qcstring.html">QCString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#a390666b66acce75e8d1baf3df72422fe">readLine</a> (bool block=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qcstring.html">QCString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#a62a56a6754de03722ebf598f4b03ef5f">readAll</a> (bool block=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#a2ad2d5259cef57e4b6907e26176999ec">writeLine</a> (const <a class="elRef" href="qcstring.html">QCString</a> &amp;line, bool addNewline=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#a8befae498020dd0dd25faedb58eca808">unreadLine</a> (const <a class="elRef" href="qcstring.html">QCString</a> &amp;line, bool addNewline=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#a7858a7a988339defcd4f1d88e7399ba5">setExitString</a> (const <a class="elRef" href="qcstring.html">QCString</a> &amp;exit)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#a6355fbb06209004a5925bfcd5190fbaa">waitForChild</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#abce600589977c5b7aaee94bf4c8cd112">WaitSlave</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#aab496808dbc7aee1d2571faa27921607">enableLocalEcho</a> (bool enable=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#a5fe99b8ab204e8f4f0135b467c9be2d2">setTerminal</a> (bool terminal)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#a215de1a53c1a9172c98f4b8466256f8a">setErase</a> (bool erase)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#ab0ac90d35272df6dc67a9fed3e9cea47">setEnvironment</a> (const <a class="elRef" href="qvaluelist.html">QCStringList</a> &amp;env)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#a203b2593dc666fb0e6862bdbd215fb8d">fd</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#a5f09dc5ba0f59ad4359aa80401d0d026">pid</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#a131b9711d9b7940e23a8453f56619bfa">waitMS</a> (int fd, int ms)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPtyProcess.html#a6c8c5e6eb93c0c9378bf21d94f60d1aa">checkPid</a> (pid_t pid)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab920eff9763fb870cd6f8e27ea5283cc"></a><!-- doxytag: member="PtyProcess::checkPidExited" ref="ab920eff9763fb870cd6f8e27ea5283cc" args="(pid_t pid)" -->
static int&#160;</td><td class="memItemRight" valign="bottom"><b>checkPidExited</b> (pid_t pid)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15d7b0464f18e889ae7cfbce017818b1"></a><!-- doxytag: member="PtyProcess::environment" ref="a15d7b0464f18e889ae7cfbce017818b1" args="() const " -->
const <a class="elRef" href="qvaluelist.html">QCStringList</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>environment</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a596b0a5ed288182e75fc96bbf358c3b9"></a><!-- doxytag: member="PtyProcess::virtual_hook" ref="a596b0a5ed288182e75fc96bbf358c3b9" args="(int id, void *data)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>virtual_hook</b> (int id, void *data)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3eba7348d41c08603a005cedbbe9f866"></a><!-- doxytag: member="PtyProcess::m_bErase" ref="a3eba7348d41c08603a005cedbbe9f866" args="" -->
bool&#160;</td><td class="memItemRight" valign="bottom"><b>m_bErase</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a872d5af94ef856a16a77aeeac78af075"></a><!-- doxytag: member="PtyProcess::m_bTerminal" ref="a872d5af94ef856a16a77aeeac78af075" args="" -->
bool&#160;</td><td class="memItemRight" valign="bottom"><b>m_bTerminal</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef4c7f999739b50851d5b0e8bbf0992d"></a><!-- doxytag: member="PtyProcess::m_Pid" ref="aef4c7f999739b50851d5b0e8bbf0992d" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>m_Pid</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a207983427e204edababedd03a1e8a7ff"></a><!-- doxytag: member="PtyProcess::m_Fd" ref="a207983427e204edababedd03a1e8a7ff" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>m_Fd</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee95dcf5ba8e6c65173c5046037be9da"></a><!-- doxytag: member="PtyProcess::m_Command" ref="aee95dcf5ba8e6c65173c5046037be9da" args="" -->
<a class="elRef" href="qcstring.html">QCString</a>&#160;</td><td class="memItemRight" valign="bottom"><b>m_Command</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71cda055ef74bcc9ae4d3d1f60aebd6d"></a><!-- doxytag: member="PtyProcess::m_Exit" ref="a71cda055ef74bcc9ae4d3d1f60aebd6d" args="" -->
<a class="elRef" href="qcstring.html">QCString</a>&#160;</td><td class="memItemRight" valign="bottom"><b>m_Exit</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Synchronous communication with tty programs. </p>
<p><a class="el" href="classPtyProcess.html" title="Synchronous communication with tty programs.">PtyProcess</a> provides synchronous communication with tty based programs. The communications channel used is a pseudo tty (as opposed to a pipe) This means that programs which require a terminal will work. </p>

<p>Definition at line <a class="el" href="process_8h_source.html#l00036">36</a> of file <a class="el" href="process_8h_source.html">process.h</a>.</p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="aae691249f6a0985de8f630e4a898dc85"></a><!-- doxytag: member="PtyProcess::checkPidStatus" ref="aae691249f6a0985de8f630e4a898dc85" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classPtyProcess.html#aae691249f6a0985de8f630e4a898dc85">PtyProcess::checkPidStatus</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Check process exit status for process <code>pid</code>. </p>
<p>On error (no child, no exit), return -1. If child <code>pid</code> has exited, return its exit status, (which may be zero). If child <code>has</code> not exited, return -2. </p>

<p>Definition at line <a class="el" href="process_8h_source.html#l00162">162</a> of file <a class="el" href="process_8h_source.html">process.h</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6c8c5e6eb93c0c9378bf21d94f60d1aa"></a><!-- doxytag: member="PtyProcess::checkPid" ref="a6c8c5e6eb93c0c9378bf21d94f60d1aa" args="(pid_t pid)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool PtyProcess::checkPid </td>
          <td>(</td>
          <td class="paramtype">pid_t&#160;</td>
          <td class="paramname"><em>pid</em></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Basic check for the existence of <code>pid</code>. </p>
<p>Returns true iff <code>pid</code> is an extant process, (one you could kill - see man kill(2) for signal 0). </p>

<p>Definition at line <a class="el" href="process_8cpp_source.html#l00075">75</a> of file <a class="el" href="process_8cpp_source.html">process.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aab496808dbc7aee1d2571faa27921607"></a><!-- doxytag: member="PtyProcess::enableLocalEcho" ref="aab496808dbc7aee1d2571faa27921607" args="(bool enable=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PtyProcess::enableLocalEcho </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enable</em> = <code>true</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Enables/disables local echo on the pseudo tty. </p>

<p>Definition at line <a class="el" href="process_8cpp_source.html#l00450">450</a> of file <a class="el" href="process_8cpp_source.html">process.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a109647b1399b9815dad3cb67e1bd86e1"></a><!-- doxytag: member="PtyProcess::exec" ref="a109647b1399b9815dad3cb67e1bd86e1" args="(const QCString &amp;command, const QCStringList &amp;args)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PtyProcess::exec </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> &amp;&#160;</td>
          <td class="paramname"><em>command</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="elRef" href="qvaluelist.html">QCStringList</a> &amp;&#160;</td>
          <td class="paramname"><em>args</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Forks off and execute a command. </p>
<p>The command's standard in and output are connected to the pseudo tty. They are accessible with readLine and writeLine. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">command</td><td>The command to execute. </td></tr>
    <tr><td class="paramname">args</td><td>The arguments to the command. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="process_8cpp_source.html#l00324">324</a> of file <a class="el" href="process_8cpp_source.html">process.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a203b2593dc666fb0e6862bdbd215fb8d"></a><!-- doxytag: member="PtyProcess::fd" ref="a203b2593dc666fb0e6862bdbd215fb8d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PtyProcess::fd </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the filedescriptor of the process. </p>

<p>Definition at line <a class="el" href="process_8h_source.html#l00121">121</a> of file <a class="el" href="process_8h_source.html">process.h</a>.</p>

</div>
</div>
<a class="anchor" id="a5f09dc5ba0f59ad4359aa80401d0d026"></a><!-- doxytag: member="PtyProcess::pid" ref="a5f09dc5ba0f59ad4359aa80401d0d026" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PtyProcess::pid </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the pid of the process. </p>

<p>Definition at line <a class="el" href="process_8h_source.html#l00126">126</a> of file <a class="el" href="process_8h_source.html">process.h</a>.</p>

</div>
</div>
<a class="anchor" id="a62a56a6754de03722ebf598f4b03ef5f"></a><!-- doxytag: member="PtyProcess::readAll" ref="a62a56a6754de03722ebf598f4b03ef5f" args="(bool block=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="qcstring.html">QCString</a> PtyProcess::readAll </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>block</em> = <code>true</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Read all available output from the program's standard out. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">block</td><td>If no output is in the buffer, should the function block </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The output. </dd></dl>

<p>Definition at line <a class="el" href="process_8cpp_source.html#l00247">247</a> of file <a class="el" href="process_8cpp_source.html">process.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a390666b66acce75e8d1baf3df72422fe"></a><!-- doxytag: member="PtyProcess::readLine" ref="a390666b66acce75e8d1baf3df72422fe" args="(bool block=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="qcstring.html">QCString</a> PtyProcess::readLine </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>block</em> = <code>true</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Reads a line from the program's standard out. </p>
<p>Depending on the <em>block</em> parameter, this call blocks until a single, full line is read. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">block</td><td>Block until a full line is read? </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The output string. </dd></dl>

<p>Definition at line <a class="el" href="process_8cpp_source.html#l00175">175</a> of file <a class="el" href="process_8cpp_source.html">process.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ab0ac90d35272df6dc67a9fed3e9cea47"></a><!-- doxytag: member="PtyProcess::setEnvironment" ref="ab0ac90d35272df6dc67a9fed3e9cea47" args="(const QCStringList &amp;env)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PtyProcess::setEnvironment </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" href="qvaluelist.html">QCStringList</a> &amp;&#160;</td>
          <td class="paramname"><em>env</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set additinal environment variables. </p>

<p>Definition at line <a class="el" href="process_8cpp_source.html#l00159">159</a> of file <a class="el" href="process_8cpp_source.html">process.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a215de1a53c1a9172c98f4b8466256f8a"></a><!-- doxytag: member="PtyProcess::setErase" ref="a215de1a53c1a9172c98f4b8466256f8a" args="(bool erase)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PtyProcess::setErase </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>erase</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Overwrites the password as soon as it is used. </p>
<p>Relevant only to some subclasses. </p>

<p>Definition at line <a class="el" href="process_8h_source.html#l00111">111</a> of file <a class="el" href="process_8h_source.html">process.h</a>.</p>

</div>
</div>
<a class="anchor" id="a7858a7a988339defcd4f1d88e7399ba5"></a><!-- doxytag: member="PtyProcess::setExitString" ref="a7858a7a988339defcd4f1d88e7399ba5" args="(const QCString &amp;exit)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PtyProcess::setExitString </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> &amp;&#160;</td>
          <td class="paramname"><em>exit</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the exit string. </p>
<p>If a line of program output matches this, <a class="el" href="classPtyProcess.html#a6355fbb06209004a5925bfcd5190fbaa" title="Waits for the child to exit.">waitForChild()</a> will terminate the program and return. </p>

<p>Definition at line <a class="el" href="process_8h_source.html#l00083">83</a> of file <a class="el" href="process_8h_source.html">process.h</a>.</p>

</div>
</div>
<a class="anchor" id="a5fe99b8ab204e8f4f0135b467c9be2d2"></a><!-- doxytag: member="PtyProcess::setTerminal" ref="a5fe99b8ab204e8f4f0135b467c9be2d2" args="(bool terminal)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PtyProcess::setTerminal </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>terminal</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Enables/disables terminal output. </p>
<p>Relevant only to some subclasses. </p>

<p>Definition at line <a class="el" href="process_8h_source.html#l00105">105</a> of file <a class="el" href="process_8h_source.html">process.h</a>.</p>

</div>
</div>
<a class="anchor" id="a8befae498020dd0dd25faedb58eca808"></a><!-- doxytag: member="PtyProcess::unreadLine" ref="a8befae498020dd0dd25faedb58eca808" args="(const QCString &amp;line, bool addNewline=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PtyProcess::unreadLine </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> &amp;&#160;</td>
          <td class="paramname"><em>line</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>addNewline</em> = <code>true</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Puts back a line of input. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">line</td><td>The line to put back. </td></tr>
    <tr><td class="paramname">addNewline</td><td>Adds a '<br/>
' to the line. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="process_8cpp_source.html#l00311">311</a> of file <a class="el" href="process_8cpp_source.html">process.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a6355fbb06209004a5925bfcd5190fbaa"></a><!-- doxytag: member="PtyProcess::waitForChild" ref="a6355fbb06209004a5925bfcd5190fbaa" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PtyProcess::waitForChild </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Waits for the child to exit. </p>
<p>See also setExitString. </p>

<p>Definition at line <a class="el" href="process_8cpp_source.html#l00486">486</a> of file <a class="el" href="process_8cpp_source.html">process.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a131b9711d9b7940e23a8453f56619bfa"></a><!-- doxytag: member="PtyProcess::waitMS" ref="a131b9711d9b7940e23a8453f56619bfa" args="(int fd, int ms)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PtyProcess::waitMS </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>fd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>ms</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Wait <code>ms</code> miliseconds (ie. </p>
<p>1/10th of a second is 100ms), using <code>fd</code> as a filedescriptor to wait on. Returns select(2)'s result, which is -1 on error, 0 on timeout, or positive if there is data on one of the selected fd's.</p>
<p><code>ms</code> must be in the range 0..999 (ie. the maximum wait duration is 999ms, almost one second). </p>

<p>Definition at line <a class="el" href="process_8cpp_source.html#l00059">59</a> of file <a class="el" href="process_8cpp_source.html">process.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="abce600589977c5b7aaee94bf4c8cd112"></a><!-- doxytag: member="PtyProcess::WaitSlave" ref="abce600589977c5b7aaee94bf4c8cd112" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PtyProcess::WaitSlave </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Waits until the pty has cleared the ECHO flag. </p>
<p>This is useful when programs write a password prompt before they disable ECHO. Disabling it might flush any input that was written. </p>

<p>Definition at line <a class="el" href="process_8cpp_source.html#l00412">412</a> of file <a class="el" href="process_8cpp_source.html">process.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a2ad2d5259cef57e4b6907e26176999ec"></a><!-- doxytag: member="PtyProcess::writeLine" ref="a2ad2d5259cef57e4b6907e26176999ec" args="(const QCString &amp;line, bool addNewline=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PtyProcess::writeLine </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" href="qcstring.html">QCString</a> &amp;&#160;</td>
          <td class="paramname"><em>line</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>addNewline</em> = <code>true</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Writes a line of text to the program's standard in. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">line</td><td>The text to write. </td></tr>
    <tr><td class="paramname">addNewline</td><td>Adds a '<br/>
' to the line. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="process_8cpp_source.html#l00302">302</a> of file <a class="el" href="process_8cpp_source.html">process.cpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="process_8h_source.html">process.h</a></li>
<li><a class="el" href="process_8cpp_source.html">process.cpp</a></li>
</ul>
</div>
    </div></div>


      </td>
  </tr>
  <tr>
    <td valign="top" id="leftmenu" width="25%">
      <a name="navigation"></a>
      <div class="menu_box"><h2>kdesu</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
  <option value="classKCookie.html">kcookie</option>,  <option value="classKDEsuClient.html">kdesuclient</option>,  <option value="classPTY.html">pty</option>,  <option value="classPtyProcess.html">ptyprocess</option>,  <option value="classSshProcess.html">sshprocess</option>,  <option value="classStubProcess.html">stubprocess</option>,  <option value="classSuProcess.html">suprocess</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li>&nbsp;&nbsp;<a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li>&nbsp;&nbsp;<a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li>&nbsp;&nbsp;<a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li>&nbsp;&nbsp;<a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li>&nbsp;&nbsp;<a href="../../kio/kfile/html/index.html">kfile</a></li><li>&nbsp;&nbsp;<a href="../../kio/kio/html/index.html">kio</a></li><li>&nbsp;&nbsp;<a href="../../kio/kioexec/html/index.html">kioexec</a></li><li>&nbsp;&nbsp;<a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li>&nbsp;&nbsp;<a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li>&nbsp;&nbsp;<a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li>&nbsp;&nbsp;<a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>


        </td>
</tr>
</table>

<span class="doNotDisplay">
  <a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
  <a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
  <a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>


<div style="height: 8px"></div>

<div id="footer">
  <div id="footer_left">
    Maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">Allen Winter</a>.
<br/>
    KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
    <a href="http://www.kde.org/contact/impressum.php">Legal</a>
  </div>
  <div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>

<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->

</body>
</html>