Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
Loading...
Searching...
No Matches
RDevice Class Reference

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

#include <e32std.h>

Inheritance diagram for RDevice:
RHandleBase

Public Member Functions

TInt Open (const TFindLogicalDevice &aFind, TOwnerType aType=EOwnerProcess)
 Opens a handle to an LDD factory object found using a TFindLogicalDevice object.
 
IMPORT_C TInt Open (const TDesC &aName, TOwnerType aType=EOwnerProcess)
 Opens a handle to an LDD factory object by name.
 
IMPORT_C void GetCaps (TDes8 &aDes) const
 Gets the device capabilities.
 
IMPORT_C TBool QueryVersionSupported (const TVersion &aVer) const
 Checks if a device supports a particular version.
 
IMPORT_C TBool IsAvailable (TInt aUnit, const TDesC *aPhysicalDevice, const TDesC8 *anInfo) const
 Checks if a specified unit number, additional info and a specific PDD is supported.
 
- Public Member Functions inherited from RHandleBase
 RHandleBase ()
 Default constructor.
 
TInt Handle () const
 Retrieves the handle-number of the object associated with this handle.
 
void SetHandle (TInt aHandle)
 Sets the handle-number of this handle to the specified value.
 
TInt SetReturnedHandle (TInt aHandleOrError)
 Sets the handle-number of this handle to the specified value.
 
IMPORT_C void Close ()
 Closes the handle.
 
IMPORT_C TName Name () const
 Gets the name of the handle.
 
IMPORT_C TFullName FullName () const
 Gets the full name of the handle.
 
IMPORT_C void FullName (TDes &aName) const
 Gets the full name of the handle.
 
IMPORT_C void SetHandleNC (TInt aHandle)
 Sets the handle-number of this handle to the specified value, and marks it as not closable.
 
IMPORT_C TInt Duplicate (const RThread &aSrc, TOwnerType aType=EOwnerProcess)
 Creates a valid handle to the kernel object for which the specified thread already has a handle.
 
IMPORT_C void HandleInfo (THandleInfo *anInfo)
 Gets information about the handle.
 
IMPORT_C TUint Attributes () const
 
IMPORT_C TInt BTraceId () const
 Returns a unique object identifier for use with BTrace.
 
IMPORT_C void NotifyDestruction (TRequestStatus &aStatus)
 Internal technology API.
 

Additional Inherited Members

- Public Types inherited from RHandleBase
enum  TAttributes { EReadAccess =0x1 , EWriteAccess =0x2 , EDirectReadAccess =0x4 , EDirectWriteAccess =0x8 }
 Read/Write attributes for the handle. More...
 
- Static Public Member Functions inherited from RHandleBase
static void DoExtendedClose ()
 
- Protected Member Functions inherited from RHandleBase
 RHandleBase (TInt aHandle)
 Copy constructor.
 
IMPORT_C TInt Open (const TFindHandleBase &aHandle, TOwnerType aType)
 Opens a handle to a kernel side object found using a find-handle object.
 
TInt OpenByName (const TDesC &aName, TOwnerType aOwnerType, TInt aObjectType)
 Implementation for RXxxxx::Open/OpenGlocbal(const TDesC &aName,,TOwnerType aType) functions.
 
- Static Protected Member Functions inherited from RHandleBase
static TInt SetReturnedHandle (TInt aHandleOrError, RHandleBase &aHandle)
 
- Protected Attributes inherited from RHandleBase
TInt iHandle
 

Detailed 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(). 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.

API status
Published to all clients. Released API.

Definition at line 3264 of file e32std.h.

Member Function Documentation

◆ GetCaps()

IMPORT_C void RDevice::GetCaps ( TDes8 &  aDes) const

Gets the device capabilities.

Parameters
aDesA descriptor into which capability's information is to be written.

(generated from Symbian Developer Library)

◆ IsAvailable()

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

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

Parameters
aUnitThe requested unit number.
aPhysicalDeviceThe requested PDD name.
anInfoThe additional information.

(generated from Symbian Developer Library)

◆ Open() [1/2]

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

Opens a handle to an LDD factory object by name.

Parameters
aNameThe name of the LDD factory object to be opened.
aTypeAn enumeration whose enumerators define the ownership of this LDD factory object handle.

(generated from Symbian Developer Library)

◆ Open() [2/2]

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

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

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

Parameters
aFindA reference to the object which is used to find the LDD factory object.
aTypeAn enumeration whose enumerators define the ownership of this LDD factory object handle. If not explicitly specified, EOwnerProcess is taken as default.

(generated from Symbian Developer Library)

◆ QueryVersionSupported()

IMPORT_C TBool RDevice::QueryVersionSupported ( const TVersion &  aVer) const

Checks if a device supports a particular version.

Parameters
aVerThe requested device version.

(generated from Symbian Developer Library)


The documentation for this class was generated from the following files: