REComSession Class Reference
class REComSession : public RSessionBase |
The REComSession singleton class provides an API to identify (resolution), instantiate, and destroy interface class implementations requested by ECOM clients. It manages the session connection to the ECOM Server itself so that typically only one connection is made to the ECOM Server per thread. It provides an un-initialise function where it releases memory and handles of unused plug-ins, see the FinalClose() function. It also ensures that all necessary clean-up is performed in the event of a Leave by any of the ListImplementationsL() or CreateImplementationL() methods.
Note: Although a public default constructor is provided in this class it is strongly recommended this object is never created by users of this API on the stack or heap by value. To access the non-static methods of this API use the static OpenL() method to obtain a pointer or a reference to the single reference counted session in use. Close() must be called when finished with.
Special care must be taken when using aInstanceKey. It is a 32-bit instance key that is returned from a call to one of the CreateImplementationL() methods. This instance key must only be used with DestroyedImplementation() to identify the implementation instance for destruction, or GetImplementationUidL() to retrieve the Implementation Uid of the instance it refers to. No meaning must be attached to this instance key by ECOM clients and it must not be used for any other purpose.
REComSession::FinalClose()
Public Member Functions |
---|
| REComSession() |
IMPORT_C void | CancelNotifyOnChange(TRequestStatus &) |
IMPORT_C void | Close() |
IMPORT_C TAny * | CreateImplementationL(TUid, TUid &) |
IMPORT_C TAny * | CreateImplementationL(TUid, TInt32) |
IMPORT_C TAny * | CreateImplementationL(TUid, TUid &, TAny *) |
IMPORT_C TAny * | CreateImplementationL(TUid, TInt32, TAny *) |
IMPORT_C TAny * | CreateImplementationL(TUid, TUid &, const TEComResolverParams &) |
IMPORT_C TAny * | CreateImplementationL(TUid, TInt32, const TEComResolverParams &) |
IMPORT_C TAny * | CreateImplementationL(TUid, TUid &, TAny *, const TEComResolverParams &) |
IMPORT_C TAny * | CreateImplementationL(TUid, TInt32, TAny *, const TEComResolverParams &) |
IMPORT_C TAny * | CreateImplementationL(TUid, TUid &, const TEComResolverParams &, TUid) |
IMPORT_C TAny * | CreateImplementationL(TUid, TInt32, const TEComResolverParams &, TUid) |
IMPORT_C TAny * | CreateImplementationL(TUid, TUid &, TAny *, const TEComResolverParams &, TUid) |
IMPORT_C TAny * | CreateImplementationL(TUid, TInt32, TAny *, const TEComResolverParams &, TUid) |
IMPORT_C TAny * | CreateImplementationL(TUid, const RExtendedInterfacesArray &, TUid &, const TEComResolverParams &, TAny *) |
IMPORT_C TAny * | CreateImplementationL(TUid, const RExtendedInterfacesArray &, TInt32, const TEComResolverParams &, TAny *) |
IMPORT_C TAny * | CreateImplementationL(TUid, const RExtendedInterfacesArray &, TUid &, const TEComResolverParams &, TUid, TAny *) |
IMPORT_C TAny * | CreateImplementationL(TUid, const RExtendedInterfacesArray &, TInt32, const TEComResolverParams &, TUid, TAny *) |
IMPORT_C void | DestroyedImplementation(TUid) |
IMPORT_C void | FinalClose() |
IMPORT_C TAny * | GetExtendedInterfaceL(const TUid &, const TUid &) |
IMPORT_C TUid | GetImplementationUidL(TUid) |
IMPORT_C void | ListExtendedInterfacesL(const TUid &, RExtendedInterfacesArray &) |
IMPORT_C void | ListImplementationsL(TUid, RImplInfoPtrArray &) |
IMPORT_C void | ListImplementationsL(TUid, const TEComResolverParams &, RImplInfoPtrArray &) |
IMPORT_C void | ListImplementationsL(TUid, const TEComResolverParams &, TUid, RImplInfoPtrArray &) |
IMPORT_C void | ListImplementationsL(TUid, RImplInfoPtrArray &, TBool) |
IMPORT_C void | ListImplementationsL(TUid, const TEComResolverParams &, RImplInfoPtrArray &, TBool) |
IMPORT_C void | ListImplementationsL(TUid, const TEComResolverParams &, TUid, RImplInfoPtrArray &, TBool) |
IMPORT_C void | ListImplementationsL(TUid, RExtendedInterfacesArray &, RImplInfoPtrArray &) |
IMPORT_C void | ListImplementationsL(TUid, RExtendedInterfacesArray &, const TEComResolverParams &, RImplInfoPtrArray &) |
IMPORT_C void | ListImplementationsL(TUid, RExtendedInterfacesArray &, const TEComResolverParams &, TUid, RImplInfoPtrArray &) |
IMPORT_C void | ManuallyReleaseExtendedInterfaceL(const TUid &, const TUid &) |
IMPORT_C void | NotifyOnChange(TRequestStatus &) |
IMPORT_C REComSession & | OpenL() |
IMPORT_C void | SetGetParametersL(const TIpcArgs &) |
Private Member Functions |
---|
void | ConstructL() |
void | ListImplementationsL(TInt, TUid, const RExtendedInterfacesArray &, const TEComResolverParams &, TUid, RImplInfoPtrArray &, TBool) |
REComSession & | OpenLC() |
void | PackMatchStrAndExtendedInterfacesL(const TEComResolverParams &, const RExtendedInterfacesArray &, RBuf8 &) |
void | ProcessListExtendedInterfacesL(const TUid &, RExtendedInterfacesArray &) |
void | ReallyClose() |
TAny * | ResolveAndCreateImplL(TUid, TUid &, TAny *, TBool) |
TAny * | ResolveAndCreateImplL(TUid, const TEComResolverParams &, TUid &, TAny *, TBool) |
TAny * | ResolveAndCreateImplL(TUid, const TEComResolverParams &, TUid, TUid &, TAny *, TBool) |
TAny * | ResolveAndCreateImplL(TUid, const RExtendedInterfacesArray &, const TEComResolverParams &, TUid &, TAny *, TBool) |
TAny * | ResolveAndCreateImplL(TUid, const RExtendedInterfacesArray &, const TEComResolverParams &, TUid, TUid &, TAny *, TBool) |
TAny * | ResolveAndCreateImplL(TInt, TUid, const RExtendedInterfacesArray &, const TEComResolverParams &, TUid, TUid &, TAny *, TBool) |
Inherited Functions |
---|
| RHandleBase::Attributes()const |
| RHandleBase::BTraceId()const |
| 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) |
| RSessionBase::CreateSession(RServer2,const TVersion &) |
| RSessionBase::CreateSession(RServer2,const TVersion &,TInt) |
| RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *) |
| RSessionBase::CreateSession(const TDesC &,const TVersion &) |
| RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt) |
| RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *) |
| RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *) |
| RSessionBase::Open(RMessagePtr2,TInt,TOwnerType) |
| RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType) |
| RSessionBase::Open(TInt,TOwnerType) |
| RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType) |
| RSessionBase::Send(TInt)const |
| RSessionBase::Send(TInt,const TIpcArgs &)const |
| RSessionBase::SendReceive(TInt)const |
| RSessionBase::SendReceive(TInt,TRequestStatus &)const |
| RSessionBase::SendReceive(TInt,const TIpcArgs &)const |
| RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const |
| RSessionBase::SetReturnedHandle(TInt) |
| RSessionBase::SetReturnedHandle(TInt,RHandleBase &) |
| RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &) |
| RSessionBase::ShareAuto() |
| RSessionBase::ShareProtected() |
Constructor & Destructor Documentation
Member Functions Documentation
CancelNotifyOnChange(TRequestStatus &)
De-registers for notification messages.
- Pre-condition
- REComSession must have been opened.
- Post-condition
- The caller's registeration for reciept of notifications of registry data changes has been cancelled.
Parameters
TRequestStatus & aStatus | The request status object originally passed to NotifyOnChange() for notification signalling. |
Close()
Closes the open handle on the ECOM framework. Reference count is decremented and the ECOM client/server session is closed.
- Pre-condition
-
REComSession must have been opened.
- Post-condition
-
REComSession reference count is decremented, server session closed
ConstructL()
void | ConstructL | ( | ) | [private] |
Initialisation phase of two phase construction.
-
leave
- One of the system-wide error codes
- Post-condition
-
REComSession is fully initialised.
CreateImplementationL(TUid, TUid &)
IMPORT_C TAny * | CreateImplementationL | ( | TUid | aImplementationUid, |
| TUid & | aInstanceKey |
| ) | [static] |
Instantiates an interface implementation to satisfy the specified interface.
- leave
- KErrNoMemory
- leave
- KErrNotConnected
- leave
- KErrArgument
- leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
Parameters
TUid aImplementationUid | A UID specifying the required interface implementation. |
TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
CreateImplementationL(TUid, TInt32)
IMPORT_C TAny * | CreateImplementationL | ( | TUid | aImplementationUid, |
| TInt32 | aKeyOffset |
| ) | [static] |
Instantiates an interface implementation to satisfy the specified interface.
- leave
- KErrNoMemory
- leave
- KErrNotConnected
- leave
- KErrArgument
- leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
Parameters
TUid aImplementationUid | A UID specifying the required interface implementation. |
TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
CreateImplementationL(TUid, TUid &, TAny *)
IMPORT_C TAny * | CreateImplementationL | ( | TUid | aImplementationUid, |
| TUid & | aInstanceKey, |
| TAny * | aConstructionParameters |
| ) | [static] |
Instantiates an interface implementation to satisfy the specified interface.
- leave
- KErrNoMemory
- leave
- KErrNotConnected
- leave
- KErrArgument
- leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
Parameters
TUid aImplementationUid | A UID specifying the required interface implementation. |
TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
TAny * aConstructionParameters | The parameter structure to pass to the object creation method. |
CreateImplementationL(TUid, TInt32, TAny *)
IMPORT_C TAny * | CreateImplementationL | ( | TUid | aImplementationUid, |
| TInt32 | aKeyOffset, |
| TAny * | aConstructionParameters |
| ) | [static] |
Instantiates an interface implementation to satisfy the specified interface.
- leave
- KErrNoMemory
- leave
- KErrNotConnected
- leave
- KErrArgument
- leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
Parameters
TUid aImplementationUid | A UID specifying the required interface implementation. |
TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
TAny * aConstructionParameters | The parameter structure to pass to the object creation method. |
CreateImplementationL(TUid, TUid &, const TEComResolverParams &)
Instantiates an interface implementation to satisfy the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
CreateImplementationL(TUid, TInt32, const TEComResolverParams &)
Instantiates an interface implementation to satisfy the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
CreateImplementationL(TUid, TUid &, TAny *, const TEComResolverParams &)
Instantiates an interface implementation to satisfy the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
TAny * aConstructionParameters | The parameter structure to pass to the object creation method. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. return TAny* A pointer to the instantiated interface implementation. |
CreateImplementationL(TUid, TInt32, TAny *, const TEComResolverParams &)
Instantiates an interface implementation to satisfy the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
TAny * aConstructionParameters | The parameter structure to pass to the object creation method. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
CreateImplementationL(TUid, TUid &, const TEComResolverParams &, TUid)
Instantiates an interface implementation to satisfy the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
CreateImplementationL(TUid, TInt32, const TEComResolverParams &, TUid)
Instantiates an interface implementation to satisfy the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
CreateImplementationL(TUid, TUid &, TAny *, const TEComResolverParams &, TUid)
Instantiates an interface implementation to satisfy the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
TAny * aConstructionParameters | The parameter structure to pass to the object creation method. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
CreateImplementationL(TUid, TInt32, TAny *, const TEComResolverParams &, TUid)
Instantiates an interface implementation to satisfy the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
TAny * aConstructionParameters | The parameter structure to pass to the object creation method. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
CreateImplementationL(TUid, const RExtendedInterfacesArray &, TUid &, const TEComResolverParams &, TAny *)
Instantiates an interface implementation to satisfy the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
-
leave
- Or any of the System Wide error codes
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface implementation. |
const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TAny * aConstructionParameters = NULL | The parameter structure to pass to the object creation method. Default value is NULL. |
CreateImplementationL(TUid, const RExtendedInterfacesArray &, TInt32, const TEComResolverParams &, TAny *)
Instantiates an interface implementation to satisfy the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
-
leave
- Or any of the System Wide error codes
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface implementation. |
const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TAny * aConstructionParameters = NULL | The parameter structure to pass to the object creation method. Default value is NULL. |
CreateImplementationL(TUid, const RExtendedInterfacesArray &, TUid &, const TEComResolverParams &, TUid, TAny *)
Instantiates an interface implementation to satisfy the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
-
leave
- Or any of the System Wide error codes
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface implementation. |
const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
TAny * aConstructionParameters = NULL | The parameter structure to pass to the object creation method. Default value is NULL. |
CreateImplementationL(TUid, const RExtendedInterfacesArray &, TInt32, const TEComResolverParams &, TUid, TAny *)
Instantiates an interface implementation to satisfy the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied. This leave error can happen under the following conditions: 1. There is a capability mismatch between the process creating the implementation and the DLL containing the implementation 2. The plugin DLL installed on the media card was not properly installed, either the system hash value of this plugin is missing or it is inconsistent with that calculated for the plugin DLL at load time.
-
leave
- Or any of the System Wide error codes
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface implementation. |
const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
TAny * aConstructionParameters = NULL | The parameter structure to pass to the object creation method. Default value is NULL. |
DestroyedImplementation(TUid)
IMPORT_C void | DestroyedImplementation | ( | TUid | aInstanceKey | ) | [static] |
Signals the destruction of an interface implementation to ECOM. LoadManager is responsible for destroying the implementation
- Post-condition
- The destruction of the Interface Implementation referred to by aInstanceKey
Parameters
TUid aInstanceKey | A 32-bit instance key that is returned from a call to one of the CreateImplementationL() methods. This instance key identifies the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
FinalClose()
IMPORT_C void | FinalClose | ( | ) | [static] |
This method is used in processes that have utilised the ECOM framework, it does nothing if the ECOM framework has not been initialised. Its main purpose is to release memory and close handles held on unused plug-in implementations and their associated DLLs. If is found (through reference counting) that the ECOM framework is no longer in use in the calling thread the session to the ECOM's server is also closed.
This method is called by direct users of the ECOM framework wherever possible (e.g. library, server or test code). It is safe to call it at any time outside of plug-in code as the user's scenario dictates. This maybe during a test case or just before process termination.
Note: It must never be called from within a plug-in implementations class destructor, especially following a DestroyImplementation() as there is a risk that the plug-in's supporting DLL may immediately be unloaded by the Kernel due to the closure of RLibrary handles. It can result in a KERN-EXEC if the destructor call stack is still inside the DLL that is unloaded.
Note: Processes that utilise the ECOM framework that do not use this call are at risk of a UHEAP_MARKEND generated panic in debug builds.
GetExtendedInterfaceL(const TUid &, const TUid &)
IMPORT_C TAny * | GetExtendedInterfaceL | ( | const TUid & | aInstanceKey, |
| const TUid & | aExtendedInterfaceUid |
| ) | [static] |
Returns the requested interface, NULL if it does not exist
- leave
- KErrNotFound When the supplied 32-bit implementation instance key is not recognised by ECom.
- leave
- KErrArgument When a null implementation instance key is passed as an argument to ECom.
- leave
- Any of the other System wide errors
Parameters
const TUid & aInstanceKey | A 32-bit implementation instance key that is returned from a call to one of the CreateImplementationL() methods. ECOM uses this implementation instance key when it is passed as an argument to the DestroyedImplementation() method to identify an implementation for destruction. No meaning should be attached to this implementation instance key by ECOM clients and it should not be used for any other purpose. |
const TUid & aExtendedInterfaceUid | Identifies an interface to fetch from the plug-in instance. |
GetImplementationUidL(TUid)
IMPORT_C TUid | GetImplementationUidL | ( | TUid | aInstanceKey | ) | [static] |
Gets the corresponding implementation uid for an instance key. This is typically used after a call to one of the
CreateImplementationL() methods that returns the aInstanceKey value as an output arg or by an offset (aKeyOffset).
- leave
- KErrNotFound When the supplied 32-bit implementation instance key is not recognised by ECom.
- leave
- KErrArgument When a null implementation instance key is passed as an argument to ECom.
- leave
- Any of the other System wide errors
- Post-condition
- REComSession has not changed
Parameters
TUid aInstanceKey | A 32-bit implementation instance key that is returned from a call to one of the CreateImplementationL() methods. ECOM uses this implementation instance key when it is passed as an argument to the DestroyedImplementation() method to identify an implementation for destruction. No meaning should be attached to this implementation instance key by ECOM clients and it should not be used for any other purpose. |
ListExtendedInterfacesL(const TUid &, RExtendedInterfacesArray &)
Retrieves a list of all the extended interfaces for the provided implementation.
- leave
- KErrNoMemory
- leave
- One of the system-wide error codes
Parameters
const TUid & aImplementationUid | Implementation UID to fetch the extended interfaces for. |
RExtendedInterfacesArray & aIfInfo | Return value consisting of an array containing the extended interfaces. |
ListImplementationsL(TUid, RImplInfoPtrArray &)
Retrieves a list of all the implementations which satisfy the specified interface. The aImplInfoArray on exit contains the plug-in implementations who's plug-in DLLs have sufficient capabilities to be loaded by the calling client process.
- leave
- KErrNoMemory
- leave
- KErrNotConnected
- leave
- KErrArgument
- Post-condition
- REComSession has not changed, and aImplInfoArray contains the list of Implementation information for the interface.
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
ListImplementationsL(TUid, const TEComResolverParams &, RImplInfoPtrArray &)
Retrieves a list of all the implementations which satisfy the specified interface with selection restriction to the specified parameters. The aImplInfoArray on exit contains the plug-in implementations who's plug-in DLLs have sufficient capabilities to be loaded by the calling client process.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
- Since
- 7.0
- Post-condition
-
REComSession has not changed, and aImplInfoArray contains the list of Implementation information for the interface.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
ListImplementationsL(TUid, const TEComResolverParams &, TUid, RImplInfoPtrArray &)
Retrieves a list of all the implementations which satisfy the specified interface with selection restriction to the specified parameters. The aImplInfoArray on exit contains the plug-in implementations who's plug-in DLLs have sufficient capabilities to be loaded by the calling client process. Overload with a client provided CResolver.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied
- Post-condition
-
REComSession has not changed, and aImplInfoArray contains the list of Implementation information for the interface.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid aResolverUid | The CResolver UID which identifies the resolver implementation with the required client defined behaviour. |
RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
ListImplementationsL(TUid, RImplInfoPtrArray &, TBool)
Retrieves a list of all the implementations which satisfy the specified interface. This method does not do capability check. The aImplInfoArray on exit contains the plug-in implementations .
- leave
- KErrNoMemory
- leave
- KErrNotConnected
- leave
- KErrArgument
- Post-condition
- REComSession has not changed, and aImplInfoArray contains the list of Implementation information for the interface.
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
TBool aCapabilityCheck | A boolean value EFalse , if no capability check is required ETrue otherwise. |
ListImplementationsL(TUid, const TEComResolverParams &, RImplInfoPtrArray &, TBool)
Retrieves a list of all the implementations which satisfy the specified interface with selection restriction to the specified parameters.This method does not do capability check. The aImplInfoArray on exit contains the plug-in implementations .
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
- Since
- 7.0
- Post-condition
-
REComSession has not changed, and aImplInfoArray contains the list of Implementation information for the interface.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
TBool aCapabilityCheck | A boolean value EFalse , if no capability check is required ETrue otherwise. |
ListImplementationsL(TUid, const TEComResolverParams &, TUid, RImplInfoPtrArray &, TBool)
Retrieves a list of all the implementations which satisfy the specified interface with selection restriction to the specified parameters.This method does not do capability check. The aImplInfoArray on exit contains the plug-in implementations . Overload with a client provided CResolver.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied
- Post-condition
-
REComSession has not changed, and aImplInfoArray contains the list of Implementation information for the interface.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid aResolverUid | The CResolver UID which identifies the resolver implementation with the required client defined behaviour. |
RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
TBool aCapabilityCheck | A boolean value EFalse , if no capability check is required ETrue otherwise. |
ListImplementationsL(TUid, RExtendedInterfacesArray &, RImplInfoPtrArray &)
Retrieves a list of all the implementations which satisfy the specified interface, extended Interfaces. The aImplInfoArray on exit contains the plug-in implementations who's plug-in DLLs have sufficient capabilities to be loaded by the calling client process.
- leave
- KErrNoMemory
- leave
- KErrNotConnected
- leave
- KErrArgument
- leave
- Or any of the System Wide error codes
- Post-condition
- REComSession has not changed, and aImplInfoArray contains the list of Implementation information for the interface.
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or many extended interfaces to match. Must match all extended interfaces for a match to occur. |
RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
ListImplementationsL(TUid, RExtendedInterfacesArray &, const TEComResolverParams &, RImplInfoPtrArray &)
Retrieves a list of all the implementations which satisfy the specified interface, extended interfaces, with selection restriction to the specified parameters. The aImplInfoArray on exit contains the plug-in implementations who's plug-in DLLs have sufficient capabilities to be loaded by the calling client process.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- Or any of the System Wide error codes
- Post-condition
-
REComSession has not changed, and aImplInfoArray contains the list of Implementation information for the interface.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
ListImplementationsL(TUid, RExtendedInterfacesArray &, const TEComResolverParams &, TUid, RImplInfoPtrArray &)
Retrieves a list of all the implementations which satisfy the specified interface, extended Interfaces, with selection restriction to the specified parameters. The aImplInfoArray on exit contains the plug-in implementations who's plug-in DLLs have sufficient capabilities to be loaded by the calling client process. Overload with a client provided CResolver.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrArgument
-
leave
- KErrPermissionDenied
-
leave
- Or any of the System Wide error codes
- Post-condition
-
REComSession has not changed, and aImplInfoArray contains the list of Implementation information for the interface.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid aResolverUid | The CResolver UID which identifies the resolver implementation with the required client defined behaviour. |
RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
ListImplementationsL(TInt, TUid, const RExtendedInterfacesArray &, const TEComResolverParams &, TUid, RImplInfoPtrArray &, TBool)
Retrieves a list of all the implementations which satisfy the specified interface with selection restriction to the specified parameters. Overload for internal use to ensure consistency between calls. This is the method which actually makes the IPC call.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrPermissionDenied
- Post-condition
-
REComSession has not changed, and aImplInfoArray contains the list of Implementation information for the interface.
TEComResolverParams
Parameters
TInt aServiceId | An integer specifying the ECom service variant to use. |
TUid aInterfaceUid | A UID specifying the required interface. |
const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match, Must match all extended interfaces for a match to occur. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid aResolverUid | The CResolver UID which identifies the resolver implementation with the required client defined behaviour. |
RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
TBool aCapabilityCheck = ETrue | |
ManuallyReleaseExtendedInterfaceL(const TUid &, const TUid &)
IMPORT_C void | ManuallyReleaseExtendedInterfaceL | ( | const TUid & | aInstanceKey, |
| const TUid & | aExtendedInterfaceUid |
| ) | [static] |
Releases the extended interface associated with the supplied instance. Does nothing if the interface does not exist. This interface is optional, normally the interfaces are cleaned up automatically. This can be used if it is necessary to clean up an extended interface before the automatic cleanup occurs when the instance is destroyed.
- leave
- KErrNotFound When the supplied 32-bit implementation instance key is not recognised by ECom.
- leave
- KErrArgument When a null implementation instance key is passed as an argument to ECom.
- leave
- Any of the other System wide errors
Parameters
const TUid & aInstanceKey | A 32-bit implementation instance key that is returned from a call to one of the CreateImplementationL() methods. ECOM uses this implementation instance key when it is passed as an argument to the DestroyedImplementation() method to identify an implementation for destruction. No meaning should be attached to this implementation instance key by ECOM clients and it should not be used for any other purpose. |
const TUid & aExtendedInterfaceUid | Identifies an extended interface to release. |
NotifyOnChange(TRequestStatus &)
Registers for notification messages when the underlying ECOM registration data changes. The client must not call this api again until their request is Completed as this could result in a 'stray signal'. This api should be placed first in the RunL of an Active Object otherwise changes could be lost. RunError should be implemented to cater for any Leaves. For example, it could retry after a second if the ECom server is busy rebuilding its indexes. CancelNotifyOnChange should be called to cancel this request and should NOT be part of the RunL.
- Pre-condition
-
REComSession must have been opened.
- Post-condition
- The caller is registered for receipt of notifications if the server's registry data changes.
Parameters
TRequestStatus & aStatus | A request status object to complete for notification signalling. |
OpenL()
This method returns a reference to the singleton client/server session object maintained by the ECOM client library, referenced counted. If it does not exist it is initialised and then returned. Clients should store the handle returned by refernce or by pointer. Storage by value is highly discouraged.
It is only necessary to use the Open()/Close() API directly if you need access to the notification methods. Access to the static API does not require these to be used. Please remeber each call to Open() must have an equivalent Close().
-
leave
- KErrNoMemory
-
leave
- One of the system-wide error codes
- Post-condition
-
REComSession is connected and ready to issue ECOM requests.
OpenLC()
This method returns a reference to the singleton client/server session object maintained by the ECOM client library, referenced counted. If it does not exist it is initialised and then returned.
-
leave
- KErrNoMemory
-
leave
- One of the system-wide error codes
- Post-condition
-
REComSession is connected and ready to issue ECOM requests.
PackMatchStrAndExtendedInterfacesL(const TEComResolverParams &, const RExtendedInterfacesArray &, RBuf8 &)
Pack the match string of the resolution parameter and extended interfaces into a buffer for sending to server.
Parameters
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match, Must match all extended interfaces for a match to occur. |
RBuf8 & aMatchStrExtInfBuf | The return buffer containing the information of match string and extended interfaces. |
ProcessListExtendedInterfacesL(const TUid &, RExtendedInterfacesArray &)
Process the list extended interface request.
- leave
- KErrNoMemory
- leave
- One of the system-wide error codes
Parameters
const TUid & aImplementationUid | Implementation UID to fetch the extended interfaces for. |
RExtendedInterfacesArray & aIfInfo | Return value consisting of an array containing the extended interfaces. |
ReallyClose()
void | ReallyClose | ( | ) | [private] |
The method will close the ECOM session connection.
- Pre-condition
- REComSession must have been opened
- Post-condition
- The session is closed
ResolveAndCreateImplL(TUid, TUid &, TAny *, TBool)
TAny * | ResolveAndCreateImplL | ( | TUid | aImplementationUid, |
| TUid & | aInstanceKey, |
| TAny * | aCreationParameters, |
| TBool | aCreationParamsFlag |
| ) | [private] |
Provides the instantiation method for an interface implementation that satisfies the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrPermissionDenied
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
Parameters
TUid aImplementationUid | A UID specifying the required interface implementation. |
TUid & aInstanceKey | A 32 bit instance key returned by the ECom framework that identifies the returned instance. |
TAny * aCreationParameters | A pointer to the creation parameter structure passed to the creation method when called. |
TBool aCreationParamsFlag | A boolean flag to indicate the existence or non-existence of aCreationParameters. Will be ETrue even for if the value of aCreationParameters is NULL. |
ResolveAndCreateImplL(TUid, const TEComResolverParams &, TUid &, TAny *, TBool)
Provides the instantiation method for an interface implementation that satisfies the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrPermissionDenied
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid & aInstanceKey | A 32 bit instance key returned by the ECom framework that identifies the returned instance. |
TAny * aCreationParameters | A pointer to the creation parameter structure passed to the creation method when called. |
TBool aCreationParamsFlag | A boolean flag to indicate the existence or non-existence of aCreationParameters. Will be ETrue even for if the value of aCreationParameters is NULL. |
ResolveAndCreateImplL(TUid, const TEComResolverParams &, TUid, TUid &, TAny *, TBool)
Provides the instantiation method for an interface implementation that satisfies the specified interface. Overload with a client provided CResolver.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrPermissionDenied
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
TUid & aInstanceKey | A 32 bit instance key returned by the ECom framework that identifies the returned instance. |
TAny * aCreationParameters | A pointer to the creation parameter structure passed to the creation method when called. |
TBool aCreationParamsFlag | A boolean flag to indicate the existence or non-existence of aCreationParameters. Will be ETrue even for if the value of aCreationParameters is NULL. |
ResolveAndCreateImplL(TUid, const RExtendedInterfacesArray &, const TEComResolverParams &, TUid &, TAny *, TBool)
Provides the instantiation method for an interface implementation that satisfies the specified interface.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrPermissionDenied
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid & aInstanceKey | A 32 bit instance key returned by the ECom framework that identifies the returned instance. |
TAny * aCreationParameters | A pointer to the creation parameter structure passed to the creation method when called. |
TBool aCreationParamsFlag | A boolean flag to indicate the existence or non-existence of aCreationParameters. Will be ETrue even for if the value of aCreationParameters is NULL. |
ResolveAndCreateImplL(TUid, const RExtendedInterfacesArray &, const TEComResolverParams &, TUid, TUid &, TAny *, TBool)
Provides the instantiation method for an interface implementation that satisfies the specified interface. Overload with a client provided CResolver.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrPermissionDenied
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TUid aInterfaceUid | A UID specifying the required interface. |
const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
TUid & aInstanceKey | A 32 bit instance key returned by the ECom framework that identifies the returned instance. |
TAny * aCreationParameters | A pointer to the creation parameter structure passed to the creation method when called. |
TBool aCreationParamsFlag | A boolean flag to indicate the existence or non-existence of aCreationParameters. Will be ETrue even for if the value of aCreationParameters is NULL. |
ResolveAndCreateImplL(TInt, TUid, const RExtendedInterfacesArray &, const TEComResolverParams &, TUid, TUid &, TAny *, TBool)
Provides the instantiation method for an interface implementation that satisfies the specified interface. Overload for internal use to ensure consistency between calls. This is the method which actually makes the IPC call.
-
leave
- KErrNoMemory
-
leave
- KErrNotConnected
-
leave
- KErrPermissionDenied
- Post-condition
- The requested interface implementation is identified, and the instantiation method pointer is returned.
TEComResolverParams
Parameters
TInt aServiceId | An integer specifying the ECom service variant to use. |
TUid aInterfaceUid | A UID specifying the required interface. |
const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
TUid & aInstanceKey | A 32 bit instance key returned by the ECom framework that identifies the returned instance. |
TAny * aCreationParameters | A pointer to the creation parameter structure passed to the creation method when called. |
TBool aCreationParamsFlag | A boolean flag to indicate the existence or non-existence of aCreationParameters. Will be ETrue even for if the value of aCreationParameters is NULL. |
SetGetParametersL(const TIpcArgs &)
IMPORT_C void | SetGetParametersL | ( | const TIpcArgs & | aArgs | ) | [static] |
This method is provided for the internal testing of the ECOM component.
- leave
- ... One of the system-wide error codes
Parameters
const TIpcArgs & aArgs | Arguments used for sending and receiving parameters |
Member Data Documentation
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.