Symbian^3 Application Developer Library >

RNetDatabase Class Reference

class RNetDatabase : public RSubSessionBase

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.

Inherits from

Public Member Functions
IMPORT_C void Add (const TDesC8 &, TRequestStatus &)
IMPORT_C TInt Add (const TDesC8 &)
IMPORT_C void Cancel ()
IMPORT_C void Close ()
IMPORT_C TInt Open ( RSocketServ &, TUint , TUint )
IMPORT_C void Query (const TDesC8 &, TDes8 &, TRequestStatus &)
IMPORT_C TInt Query (const TDesC8 &, TDes8 &)
IMPORT_C void Remove (const TDesC8 &, TRequestStatus &)
IMPORT_C TInt Remove (const TDesC8 &)
Inherited Functions
RSubSessionBase::CloseSubSession(TInt)
RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::RSubSessionBase()
RSubSessionBase::Send(TInt)const
RSubSessionBase::Send(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt)const
RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSubSessionBase::Session()const
RSubSessionBase::SubSessionHandle()const

Member Functions Documentation

Add(const TDesC8 &, TRequestStatus &)

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

Adds a record to the database asynchronously.

capability
Dependent on the type of connection so deferred to PRT

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.

Add(const TDesC8 &)

IMPORT_C TInt Add ( const TDesC8 & anItem )

Adds a record to the database.

capability
Dependent on the type of connection so deferred to PRT

Parameters

const TDesC8 & anItem The record to add

Cancel()

IMPORT_C void Cancel ( )

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

Close()

IMPORT_C void Close ( )

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.

Open(RSocketServ &, TUint, TUint)

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

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

Query(const TDesC8 &, TDes8 &, TRequestStatus &)

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

Makes a query to the database asynchronously.

capability
Dependent on the type of connection so deferred to PRT

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.

Query(const TDesC8 &, TDes8 &)

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

Makes a query to the database.

capability
Dependent on the type of connection so deferred to PRT

Parameters

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

Remove(const TDesC8 &, TRequestStatus &)

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

Removes a record from the database asynchronously.

capability
Dependent on the type of connection so deferred to PRT

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.

Remove(const TDesC8 &)

IMPORT_C TInt Remove ( const TDesC8 & anItem )

Removes a record from the database.

capability
Dependent on the type of connection so deferred to PRT

Parameters

const TDesC8 & anItem The record to remove

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.