Class ProcessEnum[in Process]

Provides a list of currently executed process.

class ProcessEnum

more...

Summary

cmdLineComplete path of the program that started the process.
nameSymbolic name of the process.
parentPidID of the process.
pidID (usually numeric) identifying a process in the system; this value can be directly fed as a parameter for function accepting process IDs.
close()Closes the enumeration freeing system resources.
next()Fills the properties of this class with the next entry in the process table.

Detailed description

class ProcessEnum


Provides a list of currently executed process.

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.

 enum = ProcessEnum()

while enum.next()
   > enum.name, ":", enum.pid, "( child of ", enum.parentPid, ")"
end

The next() method will fill the object properties with the data of a new element, until it returns false.

Properties

cmdLine

Complete path of the program that started the process.

name

Symbolic name of the process.

parentPid

ID of the process.

pid

ID (usually numeric) identifying a process in the system; this value can be directly fed as a parameter for function accepting process IDs.

Methods

close()

Closes the enumeration freeing system resources.

ProcessEnum.close( )

Disposes the data associated with this item without waiting for the garbage collector to reclaim them.

next()

Fills the properties of this class with the next entry in the process table.

ProcessEnum.next( )

Returns:True if there is an element that will fill the properties, false if the element enumeration terminated.
Raises:
ProcessErroron system error.

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.


Made with faldoc 2.2.1