#include <e32std.h>
class RProcess : public RHandleBase |
Public Member Enumerations | |
---|---|
enum | TDataCaging { EDataCagingOff, EDataCagingOn, EDataCagingQuery } |
enum | TSecureApi { ESecureApiOff, ESecureApiOn, ESecureApiQuery } |
Inherited Attributes | |
---|---|
RHandleBase::iHandle |
Inherited Enumerations | |
---|---|
RHandleBase:TAttributes |
A handle to a process.
The process itself is a kernel object.
Legacy Platform Security development and migration support DeprecatedNo replacement
Enumerator | Value | Description |
---|---|---|
EDataCagingOff | ||
EDataCagingOn | ||
EDataCagingQuery |
Legacy Platform Security development and migration support DeprecatedNo replacement
Enumerator | Value | Description |
---|---|---|
ESecureApiOff | ||
ESecureApiOn | ||
ESecureApiQuery |
RProcess | ( | ) | [inline] |
Default constructor.
The constructor exists to initialise private data within this handle; it does not create the process object.
Specifically, it sets the handle-number to the value KCurrentProcessHandle. In effect, the constructor creates a default process handle.
RProcess | ( | TInt | aHandle | ) | [inline] |
Constructor taking a handle number.
Parameters | |
---|---|
aHandle | The handle number to be used to construct this RProcess handle. |
IMPORT_C TInt | Create | ( | const TDesC & | aFileName, |
const TDesC & | aCommand, | |||
TOwnerType | aType = EOwnerProcess | |||
) |
Starts a new process, loading the specified executable.
The executable can be in ROM or RAM.
By default, ownership of this process handle is vested in the current process, but can be vested in the current thread by specifying EOwnerThread as the third parameter to this function.
Parameters | |
---|---|
aFileName | A descriptor containing the full path name of the executable to be loaded. If this name has no file extension, an extension of .EXE is appended. The length of the resulting full path name must not be greater than KMaxFileName. The length of the file name itself must not be greater than KMaxProcessName. If no path is specified, the system will look in \sys\bin on all drives. |
aCommand | A descriptor containing data passed as an argument to the thread function of the new process's main thread, when it is first scheduled. |
aType | Defines the ownership of this process handle. If not specified, EOwnerProcess is the default. |
IMPORT_C TInt | Create | ( | const TDesC & | aFileName, |
const TDesC & | aCommand, | |||
const TUidType & | aUidType, | |||
TOwnerType | aType = EOwnerProcess | |||
) |
Starts a new process, loading the specified executable which matches the specified UID type.
The executable can be in ROM or RAM.
By default, ownership of this process handle is vested in the current process, but can be vested in the current thread by specifying EOwnerThread as the fourth parameter.
Parameters | |
---|---|
aFileName | A descriptor containing the full path name of the executable to be loaded. If this name has no file extension, an extension of .EXE is appended. The length of the resulting full path name must not be greater than KMaxFileName. The length of the file name itself must not be greater than KMaxProcessName. If no path is specified, the system will look in \sys\bin on all drives. |
aCommand | A descriptor containing data passed as an argument to the thread function of the new process's main thread, when it is first scheduled. |
aUidType | A UID type (a triplet of UIDs) which the executable must match. |
aType | Defines the ownership of this process handle. If not specified, EOwnerProcess is the default. |
IMPORT_C TInt | CreateWithStackOverride | ( | const TDesC & | aFileName, |
const TDesC & | aCommand, | |||
const TUidType & | aUidType, | |||
TInt | aMinStackSize, | |||
TOwnerType | aType | |||
) |
Starts a new process, loading the specified executable which matches the specified UID type and the minimum stack size is the specified value.
The executable can be in ROM or RAM.
By default, ownership of this process handle is vested in the current process, but can be vested in the current thread by specifying EOwnerThread as the fourth parameter.
Parameters | |
---|---|
aFileName | A descriptor containing the full path name of the executable to be loaded. If this name has no file extension, an extension of .EXE is appended. The length of the resulting full path name must not be greater than KMaxFileName. The length of the file name itself must not be greater than KMaxProcessName. If no path is specified, the system will look in \sys\bin on all drives. |
aCommand | A descriptor containing data passed as an argument to the thread function of the new process's main thread, when it is first scheduled. |
aUidType | A UID type (a triplet of UIDs) which the executable must match. |
aMinStackSize | Minimum stack size of the new process. If this is less than than the stack size set in the image header of the executable, the minimum stack size will be set to the image header stack size. |
aType | Defines the ownership of this process handle. If not specified, EOwnerProcess is the default. |
Legacy Platform Security development and migration support DeprecatedNo replacement
IMPORT_C TBool | DefaultDataPaged | ( | ) | const |
This can be used to determine whether the data for the process is demand paged by default or not.
IMPORT_C TAny * | ExeExportData | ( | void | ) | [static] |
Retrieves pointer to named symbol export data from the current process, i.e. the process calling this function.
IMPORT_C TExitCategoryName | ExitCategory | ( | ) | const |
Gets the name of the category associated with the end of the process.
The category name together with the reason number is a way of distinguishing between different causes of process termination.
If the process has panicked, the category name is the panic category name; for example, E32USER-CBase or KERN-EXEC. If the process has ended as a result of a call to Kill(), then the category name is Kill.
If the process has not ended, then the category name is empty, i.e. the length of the category name is zero.
See also: RProcess::Kill()
IMPORT_C TInt | ExitReason | ( | ) | const |
Gets the specific reason associated with the end of this process.
The reason number together with the category name is a way of distinguishing between different causes of process termination.
If the process has panicked, this value is the panic number. If the process has ended as a result of a call to Kill(), then the value is the one supplied by Kill().
If the process has not ended, then the returned value is zero.
See also: RProcess::Kill()
IMPORT_C TExitType | ExitType | ( | ) | const |
Tests whether the process has ended and, if it has ended, return how it ended.
This information allows the caller to distinguish between normal termination and a panic.
IMPORT_C TFileName | FileName | ( | ) | const |
Gets a copy of the full path name of the loaded executable on which this process is based.
This is the file name which is passed to the Create() member function of this RProcess.
See also: RProcess::Create()
IMPORT_C TInt | GetMemoryInfo | ( | TModuleMemoryInfo & | aInfo | ) | const |
Gets the size and base address of the code and various data sections of the process.
The run addresses are also returned.
Parameters | |
---|---|
aInfo | On successful return, contains the base address and size of the sections. |
TBool | HasCapability | ( | TCapability | aCapability, |
const char * | aDiagnostic = 0 | |||
) | const [inline] |
Check if the process has a given capability
When a check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return ETrue even though the check failed.
Parameters | |
---|---|
aCapability | The capability to test. |
aDiagnostic | A string that will be emitted along with any diagnostic message that may be issued if the test finds the capability is not present. This string must be enclosed in the __PLATSEC_DIAGNOSTIC_STRING macro which enables it to be easily removed from the system. |
TBool | HasCapability | ( | TCapability | aCapability1, |
TCapability | aCapability2, | |||
const char * | aDiagnostic = 0 | |||
) | const [inline] |
Check if the process has both of the given capabilities
When a check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return ETrue even though the check failed.
Parameters | |
---|---|
aCapability1 | The first capability to test. |
aCapability2 | The second capability to test. |
aDiagnostic | A string that will be emitted along with any diagnostic message that may be issued if the test finds a capability is not present. This string must be enclosed in the __PLATSEC_DIAGNOSTIC_STRING macro which enables it to be easily removed from the system. |
IMPORT_C TBool | JustInTime | ( | ) | const |
Tests whether "Just In Time" debugging is enabled or not for this process.
See also: RProcess::SetJustInTime
IMPORT_C void | Kill | ( | TInt | aReason | ) |
Ends this process, and all of its threads, specifying a reason code.
This function is intended to be used if a process is exiting under normal conditions.
If the process is system permanent, the entire system is rebooted.
See also: User::SetProcessCritical() User::ProcessCritical()
Parameters | |
---|---|
aReason | The reason to be associated with the ending of this process. |
Capability | |
---|---|
PowerMgmt | except when one of the following situations is true: 1. the process calling this function is the same as the process to be terminated. 2. the process calling this function created the process to be terminated, but has not yet resumed that process. |
IMPORT_C void | Logon | ( | TRequestStatus & | aStatus | ) | const |
Requests notification when this process dies, normally or otherwise.
A request for notification is an asynchronous request, and completes:
when the process terminates
if the outstanding request is cancelled by a call to RProcess::LogonCancel().
A request for notification requires memory to be allocated; if this is unavailable, then the call to Logon() returns, and the asynchronous request completes immediately.
Parameters | |
---|---|
aStatus | A reference to the request status object. This contains the reason code describing the reason for the termination of the process, i.e. the value returned by a call to RProcess::ExitReason(). Alternatively, this is set to: KErrCancel, if an outstanding request is cancelled; KErrNoMemory, if there is insufficient memory to deal with the request. |
IMPORT_C TInt | LogonCancel | ( | TRequestStatus & | aStatus | ) | const |
Cancels an outstanding request for notification of the death of this process.
A request for notification must previously have been made, otherwise the function returns KErrGeneral.
The caller passes a reference to the same request status object as was passed in the original call to Logon().
See also: RProcess::Logon()
Parameters | |
---|---|
aStatus | A reference to the same request status object used in the original call to Logon(). |
IMPORT_C TInt | Open | ( | const TDesC & | aName, |
TOwnerType | aType = EOwnerProcess | |||
) |
Opens a handle to a specifically named process.
By default, ownership of this process handle is vested in the current process, but can be vested in the current thread by passing EOwnerThread as the second parameter to this function.
Parameters | |
---|---|
aName | A reference to the descriptor containing the name of the process to be opened. |
aType | An enumeration whose enumerators define the ownership of this thread handle. If not explicitly specified, EOwnerProcess is taken as default. |
IMPORT_C TInt | Open | ( | TProcessId | aId, |
TOwnerType | aType = EOwnerProcess | |||
) |
Opens a handle to the process whose process Id matches the specified process ID.
By default, ownership of this process handle is vested in the current process, but can be vested in the current thread by passing EOwnerThread as the second parameter to this function.
Parameters | |
---|---|
aId | The process Id used to find the process. |
aType | An enumeration whose enumerators define the ownership of this process handle. If not explicitly specified, EOwnerProcess is taken as default. |
TInt | Open | ( | const TFindProcess & | aFind, |
TOwnerType | aType = EOwnerProcess | |||
) | [inline] |
Opens a handle to the process found by pattern matching a name.
A TFindProcess object is used to find all processes whose full names match a specified pattern.
By default, ownership of this process handle is vested in the current process, but can be vested in the current thread by passing EOwnerThread as the second parameter to this function.
Parameters | |
---|---|
aFind | A reference to the TFindProcess object used to find the process. |
aType | An enumeration whose enumerators define the ownership of this process handle. If not explicitly specified, EOwnerProcess is taken as default. |
Panics the process and all of its owned threads, specifying the panic category name and reason code.
The length of the category name should be no greater than 16; any name with a length greater than 16 is truncated to 16.
If the process is system critical or system permanent, the entire system is rebooted.
See also: User::SetProcessCritical() User::ProcessCritical()
Parameters | |
---|---|
aCategory | A reference to the descriptor containing the text which defines the category name for this panic. |
aReason | The panic number. |
Capability | |
---|---|
PowerMgmt | except when one of the following situations is true: 1. the process calling this function is the same as the process to be terminated. 2. the process calling this function created the process to be terminated, but has not yet resumed that process. |
IMPORT_C TProcessPriority | Priority | ( | ) | const |
Gets the priority of this process.
IMPORT_C void | Rendezvous | ( | TRequestStatus & | aStatus | ) | const |
Creates a Rendezvous request with the process.
The request is an asynchronous request, and completes:
when a call is made to RProcess::Rendezvous(TInt aReason).
if the outstanding request is cancelled by a call to RProcess::RendezvousCancel()
if the process exits
if the process panics.
Note that a request requires memory to be allocated; if this is unavailable, then this call to Rendezvous() returns, and the asynchronous request completes immediately.
See also: RProcess::Rendezvous(TInt aReason) RProcess::RendezvousCancel(TRequestStatus& aStatus)
Parameters | |
---|---|
aStatus | A reference to the request status object. The Rendezvous completes normally when RProcess::Rendezvous(TInt aReason) is called, and this request status object will contain this reason code. If the process exits or panics, then this is the process exit reason value, i.e. the same value returned by RProcess::ExitReason(). Alternatively, this is set to: KErrCancel, if an outstanding request is cancelled; KErrNoMemory, if there is insufficient memory to deal with the request. |
IMPORT_C void | Rendezvous | ( | TInt | aReason | ) | [static] |
Completes all Rendezvous' with the current process.
See also: RProcess::Rendezvous(TRequestStatus& aStatus)
Parameters | |
---|---|
aReason | The reason code used to complete all rendezvous requests |
IMPORT_C TInt | RendezvousCancel | ( | TRequestStatus & | aStatus | ) | const |
Cancels a previously requested Rendezvous with the process.
The request completes with the value KErrCancel (if it was still outstanding).
See also: RProcess::Rendezvous(TRequestStatus &aStatus)
Parameters | |
---|---|
aStatus | A reference to the same request status object used in the original call to Rendezvous(TRequestStatus& aStatus). |
Legacy Platform Security development and migration support DeprecatedNo replacement
IMPORT_C TSecureId | SecureId | ( | ) | const |
Return the Secure ID of the process.
If an intended use of this method is to check that the Secure ID is a given value, then the use of a TSecurityPolicy object should be considered. E.g. Instead of something like:
RProcess& process; TInt error = process.SecureId()==KRequiredSecureId ? KErrNone : KErrPermissionDenied;
this could be used;
RProcess& process; static _LIT_SECURITY_POLICY_S0(mySidPolicy, KRequiredSecureId); TBool pass = mySidPolicy().CheckPolicy(process);
This has the benefit that the TSecurityPolicy::CheckPolicy methods are configured by the system wide Platform Security configuration. I.e. are capable of emitting diagnostic messages when a check fails and/or the check can be forced to always pass.
See also: TSecurityPolicy::CheckPolicy(RProcess aProcess, const char* aDiagnostic) const _LIT_SECURITY_POLICY_S0
IMPORT_C void | SetJustInTime | ( | TBool | aBoolean | ) | const |
Enables or disables "Just In Time" debugging for this process. This will only have an effect when running on the emulator.
"Just In Time" debugging catches a thread just before it executes a panic or exception routine. Capturing a thread early, before it is terminated, allows the developer to more closely inspect what went wrong, before the kernel removes the thread. In some cases, the developer can modify context, program counter, and variables to recover the thread. This is only possible on the emulator.
By default, "Just In Time" debugging is enabled.
Parameters | |
---|---|
aBoolean | ETrue, to enable just-in-time debugging. EFalse, to disable just-in-time debugging. |
IMPORT_C TInt | SetParameter | ( | TInt | aIndex, |
RHandleBase | aHandle | |||
) |
Sets the specified handle into the specified environment data slot for this process.
The APPARC framework (class CApaApplication etc.) uses some of the slots internally, so programs that use this framework should ensure that they only use slots available for public use.
See also: CApaApplication CApaCommandLine::EnvironmentSlotForPublicUse()
Parameters | |
---|---|
aIndex | An index that identifies the environment data slot. This is a value relative to zero; i.e. 0 is the first item/slot. This can range from 0 to 15. |
aHandle | The handle to be passed to this process. |
Panic Codes | |
---|---|
KERN-EXEC | 46 if this function is called by a thread running in a process that is not the creator of this process, or the handle is not local. |
KERN-EXEC | 51 if aSlot is negative or is greater than or equal to the value of KArgIndex. |
KERN-EXEC | 52 if the specified slot is already in use. |
IMPORT_C TInt | SetParameter | ( | TInt | aSlot, |
const RSubSessionBase & | aSession | |||
) |
Sets the specfied sub-session into the specified environment data slot for this process.
The APPARC framework (class CApaApplication etc.) uses some of the slots internally, so programs that use this framework should ensure that they only use slots available for public use.
See also: CApaApplication CApaCommandLine::EnvironmentSlotForPublicUse()
Parameters | |
---|---|
aSlot | An index that identifies the environment data slot. This is a value relative to zero; i.e. 0 is the first item/slot. This can range from 0 to 15. |
aSession | The sub-session. |
Panic Codes | |
---|---|
KERN-EXEC | 46 if this function is called by a thread running in a process that is not the creator of this process. |
KERN-EXEC | 51 if aSlot is negative or is greater than or equal to the value of KArgIndex. |
KERN-EXEC | 52 if the specified slot is already in use. |
KERN-EXEC | 53 if the length of data passed is negative. |
Sets the specified 16-bit descriptor data into the specified environment data slot for this process.
The APPARC framework (class CApaApplication etc.) uses some of the slots internally, so programs that use this framework should ensure that they only use slots available for public use.
See also: CApaApplication CApaCommandLine::EnvironmentSlotForPublicUse()
Parameters | |
---|---|
aSlot | An index that identifies the environment data slot. This is a value relative to zero; i.e. 0 is the first item/slot. This can range from 0 to 15. |
aDes | The 16-bit descriptor containing data be passed to this process. |
Panic Codes | |
---|---|
KERN-EXEC | 46 if this function is called by a thread running in a process that is not the creator of this process. |
KERN-EXEC | 51 if aSlot is negative or is greater than or equal to the value of KArgIndex. |
KERN-EXEC | 52 if the specified slot is already in use. |
KERN-EXEC | 53 if the length of data passed is negative. |
Sets the specified 8-bit descriptor data into the specified environment data slot for this process.
The APPARC framework (class CApaApplication etc.) uses some of the slots internally, so programs that use this framework should ensure that they only use slots available for public use.
See also: CApaApplication CApaCommandLine::EnvironmentSlotForPublicUse()
Parameters | |
---|---|
aSlot | An index that identifies the environment data slot. This is a value relative to zero; i.e. 0 is the first item/slot. This can range from 0 to 15. |
aDes | The 8-bit descriptor containing data be passed to this process. |
Panic Codes | |
---|---|
KERN-EXEC | 46 if this function is called by a thread running in a process that is not the creator of this process. |
KERN-EXEC | 51 if aSlot is negative or is greater than or equal to the value of KArgIndex. |
KERN-EXEC | 52 if the specified slot is already in use. |
KERN-EXEC | 53 if the length of data passed is negative. |
Sets the specfied integer value into the specified environment data slot for this process.
The APPARC framework (class CApaApplication etc.) uses some of the slots internally, so programs that use this framework should ensure that they only use slots available for public use.
See also: CApaApplication CApaCommandLine::EnvironmentSlotForPublicUse()
Parameters | |
---|---|
aSlot | An index that identifies the environment data slot. This is a value relative to zero; i.e. 0 is the first item/slot. This can range from 0 to 15. |
aData | The integer value. |
Panic Codes | |
---|---|
KERN-EXEC | 46 if this function is called by a thread running in a process that is not the creator of this process. |
KERN-EXEC | 51 if aSlot is negative or is greater than or equal to the value of KArgIndex. |
KERN-EXEC | 52 if the specified slot is already in use. |
KERN-EXEC | 53 if the length of data passed is negative. |
IMPORT_C TInt | SetPriority | ( | TProcessPriority | aPriority | ) | const |
Sets the priority of this process to one of the values defined by theTProcessPriority enumeration. The priority can be set to one of the four values:
EPriorityLow
EPriorityBackground
EPriorityForeground
EPriorityHigh
The absolute priority of all threads owned by the process (and all threads owned by those threads etc.) are re-calculated.
Notes:
The priority values EPriorityWindowServer, EPriorityFileServer, EPriorityRealTimeServer and EPrioritySupervisor are internal to Symbian OS and any attempt to explicitly set any of these priority values causes a KERN-EXEC 14 panic to be raised.
Any attempt to set the priority of a process which is protected and is different from the process owning the thread which invokes this function, causes a KERN-EXEC 1 panic to be raised.
A process can set its own priority whether it is protected or not.
Parameters | |
---|---|
aPriority | The priority value. |
IMPORT_C void | Terminate | ( | TInt | aReason | ) |
Ends this process, and all of its threads, specifying a reason code.
This function is intended to be used if a process is exiting under abnormal conditions, for example if an error condition has been detected.
If the process is system critical or system permanent, the entire system is rebooted.
See also: User::SetProcessCritical() User::ProcessCritical()
Parameters | |
---|---|
aReason | The reason to be associated with the ending of this process. |
Capability | |
---|---|
PowerMgmt | except when one of the following situations is true: 1. the process calling this function is the same as the process to be terminated. 2. the process calling this function created the process to be terminated, but has not yet resumed that process. |
IMPORT_C TUidType | Type | ( | ) | const |
Gets the Uid type associated with the process.
IMPORT_C TVendorId | VendorId | ( | ) | const |
Return the Vendor ID of the process.
If an intended use of this method is to check that the Vendor ID is a given value, then the use of a TSecurityPolicy object should be considered. E.g. Instead of something like:
RProcess& process; TInt error = process.VendorId()==KRequiredVendorId ? KErrNone : KErrPermissionDenied;
this could be used;
RProcess& process; static _LIT_SECURITY_POLICY_V0(myVidPolicy, KRequiredVendorId); TBool pass = myVidPolicy().CheckPolicy(process);
This has the benefit that the TSecurityPolicy::CheckPolicy methods are configured by the system wide Platform Security configuration. I.e. are capable of emitting diagnostic messages when a check fails and/or the check can be forced to always pass.
See also: TSecurityPolicy::CheckPolicy(RProcess aProcess, const char* aDiagnostic) const _LIT_SECURITY_POLICY_V0