Class RNetDatabase

class RNetDatabase : public RSubSessionBase;

Description

Provides an interface to network databases, such as LM-IAS with IrDA, that may be provided by particular protocol modules.

Before making any queries, a connection to a socket server session must be made.

Each function is available in both synchronous and asynchronous versions.

A single RNetDatabase can only perform one request of any type at once. A client is panicked if it makes two requests.

Particular database access services will specify the format of queries and of responses.

Derivation

• RSubSessionBase - Client-side handle to a sub-session

• RNetDatabase - Provides an interface to network databases, such as LM-IAS with IrDA, that may be provided by particular protocol modules

Members

Defined in RNetDatabase:
Add(), Add(), Cancel(), Close(), Open(), Query(), Query(), Remove(), Remove()

Inherited from RSubSessionBase:
CloseSubSession(), CreateAutoCloseSubSession(), CreateSubSession(), Send(), SendReceive(), Session(), SubSessionHandle()

IMPORT_C TInt Open(RSocketServ &aSocketServer, TUint anAddrFamily, TUint aProtocol);

Description

Initialises a database access service provided by a particular protocol. It must be called before other object functions are used.

Parameters

RSocketServ &aSocketServer The socket server session TUint anAddrFamily A constant identifying the protocol family TUint aProtocol A constant that identifies the protocol that provides the database access service

Return value

TInt KErrNone if successful otherwise another of the system-wide error codes.

Capability:

Dependent

on the type of connection so deferred to PRT

IMPORT_C void Query(const TDesC8 &aQuery, TDes8 &aResult, TRequestStatus &aStat);

Description

Makes a query to the database asynchronously.

Parameters

const TDesC8 &aQuery The query to perform TDes8 &aResult The result of the query TRequestStatus &aStat Indicates asynchronous operation and on completion contains an error code: see the system-wide error codes.

Capability:

Dependent

on the type of connection so deferred to PRT

IMPORT_C TInt Query(const TDesC8 &aQuery, TDes8 &aResult);

Description

Makes a query to the database.

Parameters

const TDesC8 &aQuery The query to perform TDes8 &aResult The result of the query

Return value

TInt KErrNone if successful otherwise another of the system-wide error codes.

Capability:

Dependent

on the type of connection so deferred to PRT

IMPORT_C void Add(const TDesC8 &anItem, TRequestStatus &aStat);

Description

Adds a record to the database asynchronously.

Parameters

const TDesC8 &anItem The record to add TRequestStatus &aStat Indicates asynchronous operation and on completion contains an error code: see the system-wide error codes.

Capability:

Dependent

on the type of connection so deferred to PRT

IMPORT_C TInt Add(const TDesC8 &anItem);

Description

Adds a record to the database.

Parameters

const TDesC8 &anItem The record to add

Return value

TInt KErrNone if successful otherwise another of the system-wide error codes.

Capability:

Dependent

on the type of connection so deferred to PRT

IMPORT_C void Remove(const TDesC8 &anItem, TRequestStatus &aStat);

Description

Removes a record from the database asynchronously.

Parameters

const TDesC8 &anItem The record to remove TRequestStatus &aStat Indicates asynchronous operation and on completion contains an error code: see the system-wide error codes.

Capability:

Dependent

on the type of connection so deferred to PRT

IMPORT_C TInt Remove(const TDesC8 &anItem);

Description

Removes a record from the database.

Parameters

const TDesC8 &anItem The record to remove

Return value

TInt KErrNone if successful otherwise another of the system-wide error codes.

IMPORT_C void Close();

Description

Closes a database access service. If a service has been opened using Open(), then it should be closed using Close(). This will ensure all associated resources are released.

IMPORT_C void Cancel();

Description

Cancels any outstanding asynchronous calls, which will return with error code KErrCancel.