Location: Symbol Reference > Classes > TJwJobObject Class
JWSCL Documentation
ContentsIndexHome
PreviousUpNext
TJwJobObject Class
Pascal
TJwJobObject = class;

TJwJobObject is the main job class. It encapsulates a job object and provides methods and properties to maintain it. There are also events that are fired on special job messages. 

All processes of a session must have the same token session id, otherwise the assignment fails.

 
Name 
Description 
 
This is the overview for the Create constructor overload. 
 
This is Destroy, a member of class TJwJobObject. 
Name 
Description 
The following tables list the members exposed by TJwJobObject. 
The methods of the TJwJobObject class are listed here. 
The properties of the TJwJobObject class are listed here. 
The events of the TJwJobObject class are listed here. 
 
Name 
Description 
 
OnNoActiveProcesses will be called when the last process terminates 
 
OnNotification can be used to be informed about changed information of a process 
 
Name 
Description 
 
AssignProcessToJobObject assigns an existing process to the job. The process must not already be assigned to a job. The process can be created with the flag CREATE_BREAKAWAY_FROM_JOB to be reassignable. 
 
GetSecurityDescriptor returns a security descriptor filled with the parts given in parameter Si. 
 
IsProcessInJob returns whether a process is assigned to the job.  
 
ResetIOThread resets the internal IO completition thread. This thread is necessary for triggering OnNotification and OnNoActiveProcesses.  
 
TerminateJobObject terminates all processes in the job with a predefined exit code. 
 
Waits on the job object with a possible timeout and returns the result of the waiting.
 
 
Name 
Description 
 
AccessMask returns the access mask of this job object as specified in Create when opening an existing job object 
 
ActiveProcessCount returns the current active count of processes in this job. May raise EJwsclWinCallFailedException if an error occurs. 
 
AllotedCPUTimeSignalState receives the signal state of the job. It is set to true if all processes has allotted their CPU time restriction; otherwise it is false. 
 
BasicAndIOInformation reads or sets basic limit and IO information of this job. May raise EJwsclWinCallFailedException if an error occurs. 
 
BasicLimitInformation reads or sets basic limit information of this job. May raise EJwsclWinCallFailedException if an error occurs. 
 
BasicUiRestrictions reads or sets basic limit and IO information of this job. This property has the same effect as property UiLimits.
May raise EJwsclWinCallFailedException if an error occurs. 
 
DataList contains all process handles and their associated data (if any) assigned by the method AssignProcessToJobObject
 
ExtendedLimitInformation reads or sets extended limit information of this job. May raise EJwsclWinCallFailedException if an error occurs. 
 
Handle returns the handle of the job 
 
This is IOHandle, a member of class TJwJobObject. 
 
IOUniqueID returns a unique IO completion ID that was assigned to the IO completion port as key ID. 
 
Lock 
Lock returns the internal thread syncronisation object. It can be used to avoid problems with several threads. It should be used for property JobObject because calls to this property may become invalid during processing.  
 
Name 
Name returns the name of the job object give at creation time. 
 
Processes returns an array of process ID values. Valud values are from low(Processes) to high(Processes). Always use a temporary variable for this property because each access to this property needs a system call. 
 
Session defines the session of the containg projects 
 
TerminateOnDestroy defines whether all processes should be terminated. If set to true and the @Classname instance is freed all processes assigned to this job are terminated. Default value is false. No process will be terminated. 
 
UiLimits reads or sets User Interface limits of this job. This property has the same effect as property BasicUIRestrictions.
May raise EJwsclWinCallFailedException if an error occurs. 
Copyright (c) 2010. All rights reserved.
This help was created by Doc-O-Matic sponsored by toolsfactory software inc.
What do you think about this topic? Send feedback!