Class RDevice

class RDevice : public RHandleBase;

Description

User side handle to an LDD factory object, an instance of a DLogicalDevice derived class.

The LDD factory object is a Kernel side object which is constructed on the Kernel heap when the logical device is opened using User::LoadLogicalDevice(const TDesC &). The handle allows the User side to get information about the logical device.

To use the device, a thread must create and use an instance of an RBusLogicalChannel derived class.

Derivation

• RHandleBase - A handle to an object.

• RDevice - ...

Members

Defined in RDevice:

• GetCaps(TDes8 &)constGets the device capabilities.
• IsAvailable(TInt,const TDesC *,const TDesC8 *)constChecks if a specified unit number, additional info and a specific PDD is support...
• Open(const TDesC &,TOwnerType)Opens a handle to an LDD factory object by name.
• Open(const TFindLogicalDevice &,TOwnerType)Opens a handle to an LDD factory object found using a TFindLogicalDevice object.
• QueryVersionSupported(const TVersion &)constChecks if a device supports a particular version.

Inherited from RHandleBase:

• Attributes()const
• BTraceId()constReturns a unique object identifier for use with BTrace
• Close()Closes the handle.
• Duplicate(const RThread &,TOwnerType)Creates a valid handle to the kernel object for which the specified thread alrea...
• FullName()constGets the full name of the handle.
• FullName(TDes &)constGets the full name of the handle.
• Handle()constRetrieves the handle-number of the object associated with this handle.
• HandleInfo(THandleInfo *)Gets information about the handle.
• Name()constGets the name of the handle.
• Open(const TFindHandleBase &,TOwnerType)Opens a handle to a kernel side object found using a find-handle object.
• RHandleBase(TInt)Copy constructor.
• SetHandle(TInt)Sets the handle-number of this handle to the specified value.
• SetHandleNC(TInt)Sets the handle-number of this handle to the specified value, and marks it as no...
• SetReturnedHandle(TInt)Sets the handle-number of this handle to the specified value.
• iHandle

inline TInt Open(const TFindLogicalDevice &aFind, TOwnerType aType=EOwnerProcess);

Description

Opens a handle to an LDD factory object found using a TFindLogicalDevice object.

ATFindLogicalDevice object is used to find all LDD factory objects whose full names match a specified pattern.

Parameters

const TFindLogicalDevice &aFind A reference to the object which is used to find the LDD factory object. TOwnerType aType An enumeration whose enumerators define the ownership of this LDD factory object handle. If not explicitly specified, EOwnerProcess is taken as default.

Return value

TInt KErrNone if successful, otherwise one of the other system wide error codes.

IMPORT_C TInt Open(const TDesC &aName, TOwnerType aType=EOwnerProcess);

Description

Opens a handle to an LDD factory object by name.

Parameters

const TDesC16 &aName The name of the LDD factory object to be opened. TOwnerType aType An enumeration whose enumerators define the ownership of this LDD factory object handle.

Return value

TInt KErrNone, if successful; otherwise one of the other system wide error codes.

IMPORT_C void GetCaps(TDes8 &aDes) const;

Description

Gets the device capabilities.

Parameters

TDes8 &aDes A descriptor into which capability's information is to be written.

IMPORT_C TBool QueryVersionSupported(const TVersion &aVer) const;

Description

Checks if a device supports a particular version.

Parameters

const TVersion &aVer The requested device version.

Return value

TBool ETrue if supported, EFalse if not.

IMPORT_C TBool IsAvailable(TInt aUnit, const TDesC *aPhysicalDevice, const TDesC8 *anInfo) const;

Description

Checks if a specified unit number, additional info and a specific PDD is supported.

Parameters

TInt aUnit The requested unit number. const TDesC16 *aPhysicalDevice The requested PDD name. const TDesC8 *anInfo The additional information.

Return value

TBool ETrue if supported, EFalse if not.