RDriver1 Class Reference

List of all members.

Classes

class  TCaps
class  TConfig

Public Types

typedef TPckgBuf< TConfigTConfigBuf

Public Member Functions

TInt Open ()
TInt GetConfig (TConfigBuf &aConfig)
TInt SetConfig (const TConfigBuf &aConfig)
void SendData (TRequestStatus &aStatus, const TDesC8 &aData)
void SendDataCancel ()
void ReceiveData (TRequestStatus &aStatus, TDes8 &aBuffer)
void ReceiveDataCancel ()

Static Public Member Functions

static const TDesC & Name ()
static TVersion VersionRequired ()

Friends

class DDriver1Channel

Detailed Description

User interface for 'Driver1'

Definition at line 35 of file driver1.h.


Member Function Documentation

TInt RDriver1::Open (  ) 

Opens a logical channel to the driver

Returns:
One of the system wide error codes.

Definition at line 129 of file driver1.h.

TInt RDriver1::GetConfig ( TConfigBuf &  aConfig  ) 

Gets the current configuration settings.

Parameters:
aConfig A structure which will be filled with the configuration settings.
Returns:
KErrNone if successful, otherwise one of the other system wide error codes.

Definition at line 139 of file driver1.h.

TInt RDriver1::SetConfig ( const TConfigBuf &  aConfig  ) 

Sets the current configuration settings.

Parameters:
aConfig The new configuration settings to be used.
Returns:
KErrInUse if there are outstanding data transfer requests. KErrArgument if any configuration values are invalid. KErrNone otherwise

Definition at line 151 of file driver1.h.

void RDriver1::SendData ( TRequestStatus &  aStatus,
const TDesC8 &  aData 
)

Sends data to the device. Only one send request may be pending at any time.

Parameters:
aStatus The request to be signalled when the data has been sent. The return value will be set to KErrNone on success; or to one of the system wide error codes when an error occurs.
aData A descriptor containing the data to be sent.

Definition at line 164 of file driver1.h.

void RDriver1::SendDataCancel (  ) 

Cancels a previous SendData request.

Definition at line 172 of file driver1.h.

void RDriver1::ReceiveData ( TRequestStatus &  aStatus,
TDes8 &  aBuffer 
)

Receives data from the device. Only one receive request may be pending at any time.

Parameters:
aStatus The request to be signalled when the data has been received. The return value will be set to KErrNone on success; or to one of the system wide error codes when an error occurs.
aBuffer A descriptor to which the received data will be written.

Definition at line 185 of file driver1.h.

void RDriver1::ReceiveDataCancel (  ) 

Cancels a previous ReceiveData() request.

Definition at line 193 of file driver1.h.

const TDesC & RDriver1::Name (  )  [static]

Gets the driver's name.

Returns:
The name of the driver

Definition at line 100 of file driver1.h.

TVersion RDriver1::VersionRequired (  )  [static]

Gets the driver's version.

Returns:
The version number of the driver

Definition at line 110 of file driver1.h.


Generated by  doxygen 1.6.2