RProcess Class Reference

#include <e32std.h>

class RProcess : public RHandleBase

Inherits from

Public Member Enumerations
enumTDataCaging { EDataCagingOff, EDataCagingOn, EDataCagingQuery }
enumTSecureApi { ESecureApiOff, ESecureApiOn, ESecureApiQuery }
Public Member Functions
RProcess()
RProcess(TInt)
IMPORT_C TIntCreate(const TDesC &, const TDesC &, TOwnerType)
IMPORT_C TIntCreate(const TDesC &, const TDesC &, const TUidType &, TOwnerType)
IMPORT_C TIntCreateWithStackOverride(const TDesC &, const TDesC &, const TUidType &, TInt, TOwnerType)
IMPORT_C TIntDataCaging(TInt)
IMPORT_C TBoolDefaultDataPaged()
IMPORT_C TAny *ExeExportData(void)
IMPORT_C TExitCategoryNameExitCategory()
IMPORT_C TIntExitReason()
IMPORT_C TExitTypeExitType()
IMPORT_C TFileNameFileName()
IMPORT_C TIntGetMemoryInfo(TModuleMemoryInfo &)
TBool HasCapability(TCapability, const char *)
TBool HasCapability(TCapability, TCapability, const char *)
IMPORT_C TProcessIdId()
TUid Identity()
IMPORT_C TBoolJustInTime()
IMPORT_C voidKill(TInt)
IMPORT_C voidLogon(TRequestStatus &)
IMPORT_C TIntLogonCancel(TRequestStatus &)
IMPORT_C TIntOpen(const TDesC &, TOwnerType)
IMPORT_C TIntOpen(TProcessId, TOwnerType)
TInt Open(const TFindProcess &, TOwnerType)
IMPORT_C voidPanic(const TDesC &, TInt)
IMPORT_C TProcessPriorityPriority()
TInt RenameMe(const TDesC &)
IMPORT_C voidRendezvous(TRequestStatus &)
IMPORT_C voidRendezvous(TInt)
IMPORT_C TIntRendezvousCancel(TRequestStatus &)
IMPORT_C voidResume()
IMPORT_C TIntSecureApi(TInt)
IMPORT_C TSecureIdSecureId()
IMPORT_C voidSetJustInTime(TBool)
IMPORT_C TIntSetParameter(TInt, RHandleBase)
IMPORT_C TIntSetParameter(TInt, const RSubSessionBase &)
IMPORT_C TIntSetParameter(TInt, const TDesC16 &)
IMPORT_C TIntSetParameter(TInt, const TDesC8 &)
IMPORT_C TIntSetParameter(TInt, TInt)
IMPORT_C TIntSetPriority(TProcessPriority)
IMPORT_C voidTerminate(TInt)
IMPORT_C TUidTypeType()
IMPORT_C TVendorIdVendorId()
Inherited Attributes
RHandleBase::iHandle
Inherited Enumerations
RHandleBase:TAttributes
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::Close()
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RHandleBase::SetReturnedHandle(TInt)
RHandleBase::SetReturnedHandle(TInt,RHandleBase &)

Detailed Description

A handle to a process.

The process itself is a kernel object.

Member Enumeration Documentation

Enum TDataCaging

Legacy Platform Security development and migration support DeprecatedNo replacement

EnumeratorValueDescription
EDataCagingOff
EDataCagingOn
EDataCagingQuery

Enum TSecureApi

Legacy Platform Security development and migration support DeprecatedNo replacement

EnumeratorValueDescription
ESecureApiOff
ESecureApiOn
ESecureApiQuery

Constructor & Destructor Documentation

RProcess ( )

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 )

RProcess(TIntaHandle)[inline]

Constructor taking a handle number.

Parameters
aHandleThe handle number to be used to construct this RProcess handle.

Member Function Documentation

Create ( const TDesC &, const TDesC &, TOwnerType )

IMPORT_C TIntCreate(const TDesC &aFileName,
const TDesC &aCommand,
TOwnerTypeaType = 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
aFileNameA 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.
aCommandA descriptor containing data passed as an argument to the thread function of the new process's main thread, when it is first scheduled.
aTypeDefines the ownership of this process handle. If not specified, EOwnerProcess is the default.
Return Value
KErrNone if successful, otherwise one of the other system-wide error codes.

Create ( const TDesC &, const TDesC &, const TUidType &, TOwnerType )

IMPORT_C TIntCreate(const TDesC &aFileName,
const TDesC &aCommand,
const TUidType &aUidType,
TOwnerTypeaType = 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
aFileNameA 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.
aCommandA descriptor containing data passed as an argument to the thread function of the new process's main thread, when it is first scheduled.
aUidTypeA UID type (a triplet of UIDs) which the executable must match.
aTypeDefines the ownership of this process handle. If not specified, EOwnerProcess is the default.
Return Value
KErrNone if successful, otherwise one of the other system-wide error codes.

CreateWithStackOverride ( const TDesC &, const TDesC &, const TUidType &, TInt, TOwnerType )

IMPORT_C TIntCreateWithStackOverride(const TDesC &aFileName,
const TDesC &aCommand,
const TUidType &aUidType,
TIntaMinStackSize,
TOwnerTypeaType
)

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
aFileNameA 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.
aCommandA descriptor containing data passed as an argument to the thread function of the new process's main thread, when it is first scheduled.
aUidTypeA UID type (a triplet of UIDs) which the executable must match.
aMinStackSizeMinimum 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.
aTypeDefines the ownership of this process handle. If not specified, EOwnerProcess is the default.
Return Value
KErrNone if successful, otherwise one of the other system-wide error codes.

DataCaging ( TInt )

IMPORT_C TIntDataCaging(TIntaState)

Legacy Platform Security development and migration support DeprecatedNo replacement

DefaultDataPaged ( )

IMPORT_C TBoolDefaultDataPaged()const

This can be used to determine whether the data for the process is demand paged by default or not.

Return Value
ETrue if the default for the process's data is to be demand paged, EFalse otherwise.

ExeExportData ( void )

IMPORT_C TAny *ExeExportData(void)[static]

Retrieves pointer to named symbol export data from the current process, i.e. the process calling this function.

Return Value
Pointer to export data when it is present, NULL if export data not found

ExitCategory ( )

IMPORT_C TExitCategoryNameExitCategory()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()

Return Value
A descriptor with a defined maximum length containing the name of the category associated with the end of the process.

ExitReason ( )

IMPORT_C TIntExitReason()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()

Return Value
The reason associated with the end of the process.

ExitType ( )

IMPORT_C TExitTypeExitType()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.

Return Value
An enumeration whose enumerators describe how the process has ended.

FileName ( )

IMPORT_C TFileNameFileName()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()

Return Value
A TBuf descriptor with a defined maximum length containing the full path name of the file.

GetMemoryInfo ( TModuleMemoryInfo & )

IMPORT_C TIntGetMemoryInfo(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
aInfoOn successful return, contains the base address and size of the sections.
Return Value
KErrNone, if successful; otherwise one of the other system wide error codes.

HasCapability ( TCapability, const char * )

TBool HasCapability(TCapabilityaCapability,
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
aCapabilityThe capability to test.
aDiagnosticA 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.
Return Value
ETrue if the process has the capability, EFalse otherwise.

HasCapability ( TCapability, TCapability, const char * )

TBool HasCapability(TCapabilityaCapability1,
TCapabilityaCapability2,
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
aCapability1The first capability to test.
aCapability2The second capability to test.
aDiagnosticA 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.
Return Value
ETrue if the process has both the capabilities, EFalse otherwise.

Id ( )

IMPORT_C TProcessIdId()const

Gets the Id of this process.

Return Value
The Id of this process.

Identity ( )

TUid Identity()const [inline]

DeprecatedUse RProcess::SecureId() instead

JustInTime ( )

IMPORT_C TBoolJustInTime()const

Tests whether "Just In Time" debugging is enabled or not for this process.

See also: RProcess::SetJustInTime

Return Value
True, when "Just In Time" debugging is enabled. False otherwise.

Kill ( TInt )

IMPORT_C voidKill(TIntaReason)

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
aReasonThe reason to be associated with the ending of this process.
Capability
PowerMgmtexcept 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.

Logon ( TRequestStatus & )

IMPORT_C voidLogon(TRequestStatus &aStatus)const

Requests notification when this process dies, normally or otherwise.

A request for notification is an asynchronous request, and completes:

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.

See also: RProcess::LogonCancel() RProcess::ExitReason()

Parameters
aStatusA 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.

LogonCancel ( TRequestStatus & )

IMPORT_C TIntLogonCancel(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
aStatusA reference to the same request status object used in the original call to Logon().
Return Value
KErrGeneral, if there is no outstanding request; KErrNone otherwise.

Open ( const TDesC &, TOwnerType )

IMPORT_C TIntOpen(const TDesC &aName,
TOwnerTypeaType = 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
aNameA reference to the descriptor containing the name of the process to be opened.
aTypeAn enumeration whose enumerators define the ownership of this thread handle. If not explicitly specified, EOwnerProcess is taken as default.
Return Value
KErrNone, if successful, otherwise one of the other system-wide error codes.

Open ( TProcessId, TOwnerType )

IMPORT_C TIntOpen(TProcessIdaId,
TOwnerTypeaType = 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
aIdThe process Id used to find the process.
aTypeAn enumeration whose enumerators define the ownership of this process handle. If not explicitly specified, EOwnerProcess is taken as default.
Return Value
KErrNone, if successful, otherwise one of the other system-wide error codes.

Open ( const TFindProcess &, TOwnerType )

TInt Open(const TFindProcess &aFind,
TOwnerTypeaType = 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
aFindA reference to the TFindProcess object used to find the process.
aTypeAn enumeration whose enumerators define the ownership of this process handle. If not explicitly specified, EOwnerProcess is taken as default.
Return Value
KErrNone if successful, otherwise one of the other system-wide error codes.

Panic ( const TDesC &, TInt )

IMPORT_C voidPanic(const TDesC &aCategory,
TIntaReason
)

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
aCategoryA reference to the descriptor containing the text which defines the category name for this panic.
aReasonThe panic number.
Capability
PowerMgmtexcept 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.

Priority ( )

IMPORT_C TProcessPriorityPriority()const

Gets the priority of this process.

Return Value
One of the TProcessPriority enumerator values.

RenameMe ( const TDesC & )

TInt RenameMe(const TDesC &aName)[static, inline]

DeprecatedUse User::RenameProcess() instead

Rendezvous ( TRequestStatus & )

IMPORT_C voidRendezvous(TRequestStatus &aStatus)const

Creates a Rendezvous request with the process.

The request is an asynchronous request, and completes:

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
aStatusA 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.

Rendezvous ( TInt )

IMPORT_C voidRendezvous(TIntaReason)[static]

Completes all Rendezvous' with the current process.

See also: RProcess::Rendezvous(TRequestStatus& aStatus)

Parameters
aReasonThe reason code used to complete all rendezvous requests

RendezvousCancel ( TRequestStatus & )

IMPORT_C TIntRendezvousCancel(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
aStatusA reference to the same request status object used in the original call to Rendezvous(TRequestStatus& aStatus).
Return Value
KErrGeneral, if there is no outstanding request, KErrNone otherwise.

Resume ( )

IMPORT_C voidResume()

Makes the first thread in the process eligible for execution.

See also: RThread::Resume()

Panic Codes
KERN-EXEC32 if the process is not yet fully loaded.

SecureApi ( TInt )

IMPORT_C TIntSecureApi(TIntaState)

Legacy Platform Security development and migration support DeprecatedNo replacement

SecureId ( )

IMPORT_C TSecureIdSecureId()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

Return Value
The Secure ID.

SetJustInTime ( TBool )

IMPORT_C voidSetJustInTime(TBoolaBoolean)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
aBooleanETrue, to enable just-in-time debugging. EFalse, to disable just-in-time debugging.

SetParameter ( TInt, RHandleBase )

IMPORT_C TIntSetParameter(TIntaIndex,
RHandleBaseaHandle
)

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
aIndexAn 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.
aHandleThe handle to be passed to this process.
Return Value
KErrNone, always.
Panic Codes
KERN-EXEC46 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-EXEC51 if aSlot is negative or is greater than or equal to the value of KArgIndex.
KERN-EXEC52 if the specified slot is already in use.

SetParameter ( TInt, const RSubSessionBase & )

IMPORT_C TIntSetParameter(TIntaSlot,
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
aSlotAn 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.
aSessionThe sub-session.
Return Value
KErrNone, if successful, otherwise one of the other system wide error codes.
Panic Codes
KERN-EXEC46 if this function is called by a thread running in a process that is not the creator of this process.
KERN-EXEC51 if aSlot is negative or is greater than or equal to the value of KArgIndex.
KERN-EXEC52 if the specified slot is already in use.
KERN-EXEC53 if the length of data passed is negative.

SetParameter ( TInt, const TDesC16 & )

IMPORT_C TIntSetParameter(TIntaSlot,
const TDesC16 &aDes
)

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
aSlotAn 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.
aDesThe 16-bit descriptor containing data be passed to this process.
Return Value
KErrNone, if successful, otherwise one of the other system wide error codes.
Panic Codes
KERN-EXEC46 if this function is called by a thread running in a process that is not the creator of this process.
KERN-EXEC51 if aSlot is negative or is greater than or equal to the value of KArgIndex.
KERN-EXEC52 if the specified slot is already in use.
KERN-EXEC53 if the length of data passed is negative.

SetParameter ( TInt, const TDesC8 & )

IMPORT_C TIntSetParameter(TIntaSlot,
const TDesC8 &aDes
)

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
aSlotAn 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.
aDesThe 8-bit descriptor containing data be passed to this process.
Return Value
KErrNone, if successful, otherwise one of the other system wide error codes.
Panic Codes
KERN-EXEC46 if this function is called by a thread running in a process that is not the creator of this process.
KERN-EXEC51 if aSlot is negative or is greater than or equal to the value of KArgIndex.
KERN-EXEC52 if the specified slot is already in use.
KERN-EXEC53 if the length of data passed is negative.

SetParameter ( TInt, TInt )

IMPORT_C TIntSetParameter(TIntaSlot,
TIntaData
)

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
aSlotAn 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.
aDataThe integer value.
Return Value
KErrNone, if successful, otherwise one of the other system wide error codes.
Panic Codes
KERN-EXEC46 if this function is called by a thread running in a process that is not the creator of this process.
KERN-EXEC51 if aSlot is negative or is greater than or equal to the value of KArgIndex.
KERN-EXEC52 if the specified slot is already in use.
KERN-EXEC53 if the length of data passed is negative.

SetPriority ( TProcessPriority )

IMPORT_C TIntSetPriority(TProcessPriorityaPriority)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
aPriorityThe priority value.
Return Value
KErrNone, if successful; otherwise one of the other system-wide error codes.

Terminate ( TInt )

IMPORT_C voidTerminate(TIntaReason)

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
aReasonThe reason to be associated with the ending of this process.
Capability
PowerMgmtexcept 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.

Type ( )

IMPORT_C TUidTypeType()const

Gets the Uid type associated with the process.

Return Value
A reference to a TUidType object containing the process type.

VendorId ( )

IMPORT_C TVendorIdVendorId()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

Return Value
The Vendor ID.