ProcessHandle

This object represents a running process.

Constructor function.

var myObject = new ProcessHandle();

var myObject = new ProcessHandle(otherProcessHandle);

var myObject = new ProcessHandle(processId);

1. otherProcessHandle - (ProcessHandle) other ProcessHandle to copy
2. processId - (integer) process identifier to manage

• (ParameterTypeError) incorrect parameter type
• (ParameterCountError) incorrect parameter count

Create a ProcessHandle representing an invalid process.

var myObject = new ProcessHandle();

Create a ProcessHandle representing a copy of otherProcessHandle.

var myObject = new ProcessHandle(otherProcessHandle);

Create a ProcessHandle linked to the process id 1337.

var myObject = new ProcessHandle(1337);

Returns a copy of this ProcessHandle.

myObject.clone();

• (ProcessHandle) a copy of this ProcessHandle

var copyOfMyObject = myObject.clone();

Returns true if this ProcessHandle and another are referencing the same process.

myObject.equals(other);

1. other - (ProcessHandle) another ProcessHandle

• (bool) true if other is referencing the same process

if(myFirstObject.equals(mySecondObject))
	//Do something

Returns a string representing this ProcessHandle.

myObject.toString();

• (string) a string representing this ProcessHandle

Console.print(myObject.toString());

This method is automatically called when trying to convert a ProcessHandle to a string.

Returns the process id.

myObject.id();

• (integer) the process id

Try to kill the process.

myObject.kill(killMode, timeout);

1. killMode - (KillMode) the kill mode to use
2. timeout - (integer) the timeout in milliseconds to wait when using GracefulThenForceful

• (boolean) true if the process was killed

Returns true if the process is currently running.

myObject.isRunning();

• (boolean) true if the process is currently running

Returns the command that was used to start this process.

myObject.command();

• (string) the command that was used to start this process

• (OpenProcessError) unable to open the process (Windows)
• (GetModuleFilenameError) unable to get the module filename (Windows)
• (GetProcessError) unable to get the process command (Linux)

Returns the priority of this process.

myObject.priority();

• (Priority) the process priority

• (OpenProcessError) unable to open the process (Windows)
• (GetPriorityClassError) unable to get priority class (Windows)
• (OperatingSystemError) this is not available on this operating system (Linux)

This method only works on Windows, because Linux doesn't have any concept of process priority.

Policy to use when trying to kill a process.

1. Graceful: Linux: send a SIGTERM signal Windows: close all windows owned by this process
2. Forceful: Linux: send a SIGKILL signal Windows: use TerminateProcess to kill this process
3. GracefulThenForceful: try to kill the process using the graceful technique, wait for timeout and kill it using the forceful technique

A process priority.

1. AboveNormal: above normal
2. BelowNormal: below normal
3. High: high
4. Idle: idle
5. Normal: normal
6. Realtime: realtime