<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Class ProcessEnum - Class ProcessEnum</title>
<link href="faldoc.css" rel="stylesheet" type="text/css"/>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
</head>
<body class="faldoc_body">
<div class="navitop">
<div class="tabs">
<ul>
<li><a href="./index.html"><span>Main</span></a></li>
<li><a href="./modules.html"><span>Modules</span></a></li>
<li><a href="./pages.html"><span>Related pages</span></a></li>
<li><a href="./groups.html"><span>Groups</span></a></li>
<li><a href="./classes.html"><span>Classes</span></a></li>
<li><a href="./objects.html"><span>Objects</span></a></li>
<li><a href="./functions.html"><span>All functions</span></a></li>
<li><a href="./enum.html"><span>Enumerations</span></a></li>
</ul>
</div>
</div>
<hr/>
<h1 class="faldoc_title">Class ProcessEnum<span class="faldoc_belong"><a href="./module_feather_process.html">[in Process]</a></p></h1>
<p class="faldoc_brief">Provides a list of currently executed process. </p>
<p class="faldoc_funcdecl">
<b>class</b> ProcessEnum
</p>
<p class="faldoc_brief"><a href="#more">more...</a></p>
<h2 class="faldoc_title">Summary</h2>
<table class="faldoc_list">
<tr><td><a href="#cmdLine">cmdLine</a></td><td>Complete path of the program that started the process.</td></tr>
<tr><td><a href="#name">name</a></td><td>Symbolic name of the process.</td></tr>
<tr><td><a href="#parentPid">parentPid</a></td><td>ID of the process.</td></tr>
<tr><td><a href="#pid">pid</a></td><td>ID (usually numeric) identifying a process in the system; this value can be directly fed as a parameter for function accepting process IDs.</td></tr>
<tr><td><a href="#close">close()</a></td><td>Closes the enumeration freeing system resources. </td></tr>
<tr><td><a href="#next">next()</a></td><td>Fills the properties of this class with the next entry in the process table. </td></tr>
</table>
<a name="more"><h2 class="faldoc_title">Detailed description</h2></a>
<p class="faldoc_funcdecl">
<b>class</b> ProcessEnum
</p>
<table class="faldoc_function">
</table>
<br/>
<p class="item_brief">Provides a list of currently executed process. </p>
<p class="faldoc_text">This class can be used to retreive a list of running processes on the host machine, with minimal informations for each of them as its name and an unique ID by which it can be identified later on. ProcessEnum constructor returns an object that can be iterated upon like in the following example. </p>
<pre class="faldoc_code">
enum = ProcessEnum()
while enum.next()
> enum.name, ":", enum.pid, "( child of ", enum.parentPid, ")"
end
</pre>
<p class="faldoc_text">The next() method will fill the object properties with the data of a new element, until it returns false. </p>
<h2 class="faldoc_title">Properties</h2>
<h3 class="faldoc_funcname"><a name="cmdLine">cmdLine</a></h3>
<p class="item_brief">Complete path of the program that started the process.</p>
<h3 class="faldoc_funcname"><a name="name">name</a></h3>
<p class="item_brief">Symbolic name of the process.</p>
<h3 class="faldoc_funcname"><a name="parentPid">parentPid</a></h3>
<p class="item_brief">ID of the process.</p>
<h3 class="faldoc_funcname"><a name="pid">pid</a></h3>
<p class="item_brief">ID (usually numeric) identifying a process in the system; this value can be directly fed as a parameter for function accepting process IDs.</p>
<h2 class="faldoc_title">Methods</h2>
<h3 class="faldoc_funcname"><a name="close">close()</a></h3>
<p class="item_brief">Closes the enumeration freeing system resources. </p>
<p class="faldoc_funcdecl">ProcessEnum.close( )</p>
<p class="faldoc_text"><p class="faldoc_text">Disposes the data associated with this item without waiting for the garbage collector to reclaim them. </p>
</p>
<h3 class="faldoc_funcname"><a name="next">next()</a></h3>
<p class="item_brief">Fills the properties of this class with the next entry in the process table. </p>
<p class="faldoc_funcdecl">ProcessEnum.next( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">True if there is an element that will fill the properties, false if the element enumeration terminated. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_ProcessError.html">ProcessError</a></td><td class="faldoc_raisedesc">on system error. </td></tr>
</table>
</td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">Fills the properties of the class with data from the next element in the process enumeration. If the previous one was the last entry, the method returns false, else it returns true and the properties are changed. </p>
</p>
<hr/>
<div class="navibottom">
<center>
<a href="./index.html">Main</a> - <a href="./modules.html">Modules</a> - <a href="./pages.html">Related pages</a> - <a href="./groups.html">Groups</a> - <a href="./classes.html">Classes</a> - <a href="./objects.html">Objects</a> - <a href="./functions.html">All functions</a> - <a href="./enum.html">Enumerations</a>
</center>
</div>
</div>
<div class="faldoc_signature">Made with <a href="http://www.falconpl.org">faldoc 2.2.0</div>
</body>
</html>
