<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
<head><meta content="text/html;charset=&quot;utf-8&quot;" http-equiv="Content-type"/><link href="faldoc.css" rel="stylesheet" type="text/css"/><title> - Class ProcessEnum</title></head><body class="faldoc"><ul class="navi_top"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="feathers_process.html">Up: External process interface</a></li>
<li class="prev"><a href="feathers_process_Process.html">Previous: Class Process</a></li>
<li class="next"><a href="feathers_process_ProcessError.html">Next: Class ProcessError</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">2.10.2</span>Class ProcessEnum</h1><p class="brief">Provides a list of currently executed process. </p>
<pre class="prototype">Class ProcessEnum</pre>
<p>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>
enum = ProcessEnum()
while enum.next()
> enum.name, ":", enum.pid, "( child of ", enum.parentPid, ")"
end
</pre><p>The next() method will fill the object properties with the data of a new element, until it returns false. </p>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Properties</td></tr>
<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 that created this 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>
</tbody>
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods</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>
</tbody>
</table>
<h2>Properties</h2><h3><a name="cmdLine">cmdLine</a></h3><p class="brief"> Complete path of the program that started the process.</p>
<p> Complete path of the program that started the process. Not always available, and not provided by all systems. </p>
<h3><a name="name">name</a></h3><p class="brief"> Symbolic name of the process.</p>
<p> Symbolic name of the process. </p>
<h3><a name="parentPid">parentPid</a></h3><p class="brief"> ID of the process that created this process.</p>
<p> ID of the process that created this process. The parent PID always represents an existing process, but it's possible that children are returned before the parent is listed. </p>
<h3><a name="pid">pid</a></h3><p class="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>
<p> 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>Methods</h2><h3><a name="close">close</a></h3><p class="brief">Closes the enumeration freeing system resources. </p>
<pre class="prototype">ProcessEnum.close()</pre>
<p>Disposes the data associated with this item without waiting for the garbage collector to reclaim them. </p>
<h3><a name="next">next</a></h3><p class="brief">Fills the properties of this class with the next entry in the process table. </p>
<pre class="prototype">ProcessEnum.next()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">True if there is an element that will fill the properties, false if the element enumeration terminated. </td></tr>
<tr class="raise"><td class="name">Raise</td><td class="content"><table>
<tbody><tr><td class="name"><a href="feathers_process_ProcessError.html">ProcessError</a></td><td class="content"> on system error. </td></tr>
</tbody>
</table>
</td></tr>
</tbody>
</table>
<p>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>
</div><ul class="navi_bottom"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="feathers_process.html">Up: External process interface</a></li>
<li class="prev"><a href="feathers_process_Process.html">Previous: Class Process</a></li>
<li class="next"><a href="feathers_process_ProcessError.html">Next: Class ProcessError</a></li>
<li class="clear"></li>
</ul><div class="signature">Made with <a href="faldoc 3.0">http://www.falconpl.org</a></div></body></html>
