$Revision$ $Date$ NSTask Foundation/NSTask.h NSObject The NSTask class provides a mechanism to run separate tasks under (limited) control of your program. launchedTaskWithLaunchPath: path arguments: arguments Creates and launches a task, returning an autoreleased task object. Supplies the path to the executable and an array of argument. The task inherits the parents environment and I/O. arguments Returns the arguments set for the task. currentDirectoryPath Returns the working directory set for the task. environment Returns the environment set for the task. interrupt Sends an interrupt signal to the receiver and any subtasks.
If the task has not been launched, raises an NSInvalidArgumentException.
Has no effect on a task that has already terminated.
This is rather like the terminate method, but the child process may not choose to terminate in response to an interrupt. isRunning Checks to see if the task is currently running. launch Launches the task.
Raises an NSInvalidArgumentException if the launch path is not set or if the subtask cannot be started for some reason (eg. the executable does not exist). launchPath Returns the launch path set for the task. processIdentifer Returns the number identifying the child process on this system. setArguments: arguments Sets an array of arguments to be supplied to the task when it is launched. The default is an empty array. This method cannot be used after a task is launched ... it raises an NSInvalidArgumentException. setCurrentDirectoryPath: path Sets the home directory in which the task is to be run. The default is the parent processes directory. This method cannot be used after a task is launched ... it raises an NSInvalidArgumentException. setEnvironment: environmentDictionary Sets the environment variables for the task to be run. The default is the parent processes environment. This method cannot be used after a task is launched ... it raises an NSInvalidArgumentException. setLaunchPath: path Sets the path to the executable file to be run. There is no default for this - you must set the launch path. This method cannot be used after a task is launched ... it raises an NSInvalidArgumentException. setStandardError: file Sets the standard error stream for the task.
This is normally a writable NSFileHandle object. If this is an NSPipe, the write end of the pipe is automatically closed on launching.
The default behavior is to inherit the parent processes stderr output.
This method cannot be used after a task is launched ... it raises an NSInvalidArgumentException. setStandardInput: file Sets the standard input stream for the task.
This is normally a readable NSFileHandle object. If this is an NSPipe, the read end of the pipe is automatically closed on launching.
The default behavior is to inherit the parent processes stdin stream.
This method cannot be used after a task is launched ... it raises an NSInvalidArgumentException. setStandardOutput: file Sets the standard output stream for the task.
This is normally a writable NSFileHandle object. If this is an NSPipe, the write end of the pipe is automatically closed on launching.
The default behavior is to inherit the parent processes stdout stream.
This method cannot be used after a task is launched ... it raises an NSInvalidArgumentException. standardError Returns the standard error stream for the task - an NSFileHandle unless an NSPipe was passed to setStandardError: standardInput Returns the standard input stream for the task - an NSFileHandle unless an NSPipe was passed to setStandardInput: standardOutput Returns the standard output stream for the task - an NSFileHandle unless an NSPipe was passed to setStandardOutput: resume Sends a cont signal to the receiver and any subtasks.
If the task has not been launched, raises an NSInvalidArgumentException.
suspend Sends a stop signal to the receiver and any subtasks.
If the task has not been launched, raises an NSInvalidArgumentException.
terminate Sends a terminate signal to the receiver and any subtasks.
If the task has not been launched, raises an NSInvalidArgumentException.
Has no effect on a task that has already terminated.
When a task temrinates, either due to this method being called, or normal termination, an NSTaskDidTerminateNotification is posted. terminationStatus Returns the termination status of the task.
If the task has not completed running, raises an NSInvalidArgumentException. usePseudoTerminal If the system supports it, this method sets the standard input, output, and error streams to a pseudo-terminal so that, when launched, the child task will act as if it was running interactively on a terminal. The file handles can then be used to communicate with the child.
This method cannot be used after a task is launched ... it raises an NSInvalidArgumentException.
The standard input, output and error streams cannot be changed after calling this method.
The method returns YES on success, NO on failure. waitUntilExit Suspends the current thread until the task terminates, by waiting in NSRunLoop (NSDefaultRunLoopMode) for the task termination.
Returns immediately if the task is not running.