This class provides several instance methods which operate on a process instance. More...

Inheritance diagram for Process:

[legend]

Collaboration diagram for Process:

[legend]

Public Member Functions
_.Library.Status	ReleaseAllLocks ()
	Release ALL locks. More...

_.Library.Status	Resume ()
	Resume a process. More...

_.Library.Status	Suspend ()
	Suspend a process. More...

_.Library.Status	Terminate (_.Library.Integer SendError)
	Terminate a process. More...

Public Member Functions inherited from ProcessQuery
def	__init__ (self)
	Number of Lines Executed. More...

Static Public Member Functions
_.Library.Integer	ProcessTableSize ()
	Current size of the process table (number of process slots).

Static Public Member Functions inherited from ProcessQuery
_.Library.Status	ExamStackByPid (_.Library.String Pid, _.Library.Boolean GetVariables, _.Library.Integer Timeout)
	Retrieve a snapshot of the execution stack and variables for a process in. More...

_.Library.List	GetAppFrameInfo (_.Library.Integer pid)
	Return the entire application metadata frame information for the current process. More...

_.Library.String	GetCPUTime (_.Library.Integer pid)
	Get CPU time used for current process (without method arguments) More...

_.Library.Integer	GetInternalStackLevel (_.Library.Integer stack, newlevels)
	Convert a $STACK value to the corresponding internal stack level that can be used. More...

_.Library.Status	GetLoginRoutine (_.Library.String Label, _.Library.String Routine)
	Get routine and label specified in process login. More...

_.Library.String	GetOSUsername ()
	This method returns the OSUsername of the process as returned by the operating system. More...

_.Library.List	GetOpenDevices (_.Library.Integer Pid)
	Get a $LIST of devices that a process has open. More...

	GetVariableList (_.Library.Integer InternalStack, ListVar)
	Get a list of all variables defined at the specified internal execution stack level. More...

_.Library.Status	KillAllPrivateGlobals ()
	Kill all process private globals for the calling process. More...

_.Library.String	NextProcess (_.Library.String Pid, _.Library.Integer Flag)
	Returns the next process pid on the system. More...

_.Library.ObjectHandle	Open (_.Library.String Id, _.Library.Integer concurrency, _.Library.Status sc)
	Open an instance to a process. More...

_.Library.Integer	VariableDataFlags (_.Library.String Variable, _.Library.Integer InternalStack)
	Get the $Data() value of a variable at the specified internal execution stack level. More...

_.Library.String	VariableQuery (_.Library.String Variable, _.Library.Integer InternalStack)
	Perform a $Query() operation on a variable reference at the specified internal execution stack level. More...

	VariableValue (_.Library.String Variable, _.Library.Integer InternalStack)
	Get the value of a variable at the specified internal execution stack level. More...

Additional Inherited Members
Public Attributes inherited from ProcessQuery
	AppFrameInfo
	The entire application metadata frame information. More...

	CPUTime
	Sum of system and user CPU Time in ms for process (no mailbox message) More...

	CSPSessionID
	CSP Session ID of client connected to process. More...

	CanBeExamined
	Process can be examined. More...

	CanBeSuspended
	Process can be suspended. More...

	CanBeTerminated
	Process can be terminated. More...

	CanReceiveBroadcast
	Process can receive broadcast. More...

	ClientExecutableName
	Executable name of the process on the client. More...

	ClientIPAddress
	IP Address of client connected to the process. More...

	ClientNodeName
	Node Name of the client connected to the process. More...

	CommandsExecuted
	Number of Commands Executed. More...

	CurrentDevice
	Current Device ($i). More...

	CurrentLineAndRoutine
	Current Line and Routine. More...

	CurrentSrcLine
	Current Source Line being executed. More...

	DataBlockWrites
	Total number of database blocks queued for writing by this process. More...

	EscalatedRoles
	Additional roles granted to the set of login roles. More...

	GlobalBlocks
	Number of Database Block Allocations. More...

	GlobalDiskReads
	Number of Physical Database Reads. More...

	GlobalReferences
	Number of Global References. More...

	GlobalUpdates
	Number of Global Updates. More...

	InTransaction
	In a transaction. More...

	IsGhost
	Is a Ghost process. More...

	JobNumber
	Job number in process table. More...

	JobType
	Job type. More...

	JournalEntries
	Number of Journal Entries. More...

	LastGlobalReference
	Last Global Reference. More...

	LicenseUserId
	User Id used for license. More...

	LinesExecuted

	Location
	Location. More...

	LoginRoles
	Login roles. More...

	MemoryAllocated
	Maximum memory able to be used in KB ($ZS). More...

	MemoryPeak
	Peak memory allocated in KB. More...

	MemoryUsed
	Memory used in KB (Current $s). More...

	NameSpace
	Namespace process is executing in. More...

	OSUserName
	Operating system username of process. More...

	OpenDevices
	List of open devices. More...

	Pid
	Process ID. More...

	PidExternal
	External Process PID. More...

	PrincipalDevice
	Principal Device ($P). More...

	Priority
	Priority. More...

	PrivateGlobalBlockCount
	Number of private global database blocks. More...

	PrivateGlobalReferences
	Number of Process Private Global References. More...

	PrivateGlobalUpdates
	Number of Process Private Global Updates. More...

	Roles
	$Roles. More...

	Routine
	Routine currently executing. More...

	StartupClientIPAddress
	Startup IP Address of client. More...

	StartupClientNodeName
	Startup Node Name of client. More...

	State
	Current state of the process as determined by the processes state bits. More...

	Switch10
	Process Owns switch 10. More...

	UserInfo
	User defined information. More...

	UserName
	$Username of process. More...

Static Public Attributes inherited from ProcessQuery
	DOMAIN = None
	Set this to the correct domain.

Detailed Description

This class provides several instance methods which operate on a process instance.

Properties/Storage/Queries are inherited from the SYS.ProcessQuery class. The methods declared here are protected methods which can only be executed on a process if they have write access to the DB_IRISSYS resource (i.e. can write to the IRISSYS database.) The process executing this query must be in the SYS namespace.

Member Function Documentation

◆ ReleaseAllLocks()

_.Library.Status ReleaseAllLocks ( )

Release ALL locks.

Release all locks for the process.

◆ Resume()

_.Library.Status Resume ( )

Resume a process.

Resumes a process after it had previously been suspended.

◆ Suspend()

_.Library.Status Suspend ( )

Suspend a process.

Put a process into a wait state so it stops executing code.

◆ Terminate()

_.Library.Status Terminate ( _.Library.Integer SendError )

Terminate a process.

Kills a process by sending it a halt message.
If SendError is 1 the killed job will issue a <Escape><</Escape>RESJOB<Escape>></Escape> error and invoke the ^ETN utility.

Public Member Functions