CApDataHandler Class Reference

API published in: S60 1st Ed
API deprecated in: S60 3rd Ed FP 2

Link against: apengine.lib

Capability Information

Required Capabilities

None

Exceptions

Functions modifying database (Create, Update, Delete) need WriteDeviceData. (CApDataHandler, CApUtils Setxxx functions)

#include <apdatahandler.h>

Detailed Description

Representation of the access point handler.

Encapsulates a session with the CommsDB Provides a way to access the database and manipulate its data.


Public Member Functions
virtual IMPORT_C	~CApDataHandler ()
	Destructor.
IMPORT_C void	AccessPointDataL (TUint32 aUid, CApAccessPointItem &aApItem)
	Reads up one access point's data from the database.
IMPORT_C void	UpdateAccessPointDataL (CApAccessPointItem &aApItem, TBool &aNameChanged)
	Updates data stored in an existing access point.
IMPORT_C TUint32	CreateCopyFromL (TUint32 aBaseId)
	Creates a copy of a previously existing access point.
IMPORT_C TUint32	CreateFromDataL (CApAccessPointItem &aApItem)
	Create a new access point from supplied data Expects that CApDataHandler has been created and the database had been opened.
IMPORT_C void	RemoveAPL (TUint32 aUid)
	Removes the given access point from the database.
IMPORT_C TUint32	DefaultL (TBool aIsWap) const
	Reads the UID of the default access point.
IMPORT_C void	SetAsDefaultL (TUint32 aUid, TCommsDbIspType aIntendedType)
	Sets the default access point.
IMPORT_C void	SetPreferredIfDbIapTypeL (TUint32 aRank, TCommDbConnectionDirection aDirection, TUint32 aBearers, TCommDbDialogPref aPrompt, TUint32 aIAP, TBool aOverwrite)
	Sets the access point preference.
IMPORT_C void	SetPreferredIfDbIspTypeL (TUint32 aRank, TCommDbConnectionDirection aDirection, TUint32 aBearers, TCommDbDialogPref aPrompt, TUint32 aISP, TUint32 aChargeCard, const TDesC &aServiceType, TBool aOverwrite)
	Sets the access point preference.
IMPORT_C void	GetPreferredIfDbIapTypeL (TUint32 aRank, TCommDbConnectionDirection aDirection, TUint32 &aBearers, TUint32 &aPrompt, TUint32 &aIAP)
	Gets the access point preference.
IMPORT_C const TDesC &	GetPreferredIfDbIspTypeL (TUint32 aRank, TCommDbConnectionDirection aDirection, TUint32 &aBearers, TUint32 &aPrompt, TUint32 &aISP, TUint32 &aChargeCard)
	Gets the access point preference.
IMPORT_C TUint32	DefaultL (TBool aIsWap, TBool &aReadOnly) const
	Reads the UID of the default access point.
IMPORT_C void	RemoveNetworkL (TUint32 aUid)
	Removes the given network group from the database.
IMPORT_C void	CreateNetworkL (CApNetworkItem &aNetwork)
	Creates a network group from the data.
IMPORT_C void	ReadNetworkPartL (CApAccessPointItem &aItem)
	Reads up a network part of the access point Network is identified by the iNetworkId of the passed access point.
IMPORT_C void	ReadNetworkL (TUint32 aUid, CApNetworkItem &aNetwork)
	Reads up a network Network is identified by passed uid.
Static Public Member Functions
static IMPORT_C CApDataHandler *	NewLC (CCommsDatabase &aDb)
	Two-phased constructor.
Protected Member Functions
IMPORT_C	CApDataHandler ()
	C++ default constructor.
IMPORT_C void	ConstructL (CCommsDatabase &aDb)
	Second-phase constructor.
void	ReadWapDataL (TUint32 aWapId, CApAccessPointItem &aApItem)
	Reads the WAP part of the data from the database.
void	ReadIapDataL (TUint32 aIapId, CApAccessPointItem &aApItem)
	Reads the IAP part of the data from the database.
void	ReadIspDataL (TUint32 aIspId, CApAccessPointItem &aApItem)
	Reads the ISP part of the data from the database.
void	ReadGprsDataL (TUint32 aIspId, CApAccessPointItem &aApItem)
	Reads the GPRS data from the database.
void	ReadCdmaDataL (TUint32 aIspId, CApAccessPointItem &aApItem)
	Reads the CDMA data from the database.
void	ReadLanDataL (TUint32 aIspId, CApAccessPointItem &aApItem)
	Reads the LAN data from the database.
void	ReadDialInOutDataL (TUint32 aIspId, CApAccessPointItem &aApItem)
	Reads the DialIn/Out ISP data from the database.
void	ReadVpnInfoL (TUint32 aIspId, CApAccessPointItem &aApItem)
	Reads up the VPN bearer type info in case of a VPN access point In case of error, leaves with CommDb error codes.
void	WriteWapBearerDataL (TBool aIsNew, TUint32 aWapId, CApAccessPointItem &aApItem)
	Writes the WAP bearer part of the data to the database.
void	WriteWapApDataL (TBool aIsNew, TUint32 aWapId, CApAccessPointItem &aApItem)
	Writes the WAP AP part of the data to the database.
void	WriteIapDataL (TBool aIsNew, TUint32 aIapId, CApAccessPointItem &aApItem)
	Writes the IAP part of the data to the database.
void	WriteIspDataL (TBool aIsNew, TUint32 aIspId, CApAccessPointItem &aApItem)
	Writes the ISP part of the data to the database.
void	WriteCdmaDataL (TBool aIsNew, CApAccessPointItem &aApItem)
	Writes the Cdma data to the database.
void	WriteGprsDataL (TBool aIsNew, CApAccessPointItem &aApItem)
	Writes the Gprs data to the database.
void	WriteLanDataL (TBool aIsNew, CApAccessPointItem &aApItem)
	Writes the LAN data to the database.
TUint32	DoUpdateAccessPointDataL (CApAccessPointItem &aApItem, TBool aIsNew, TBool &aNameChanged)
	Writes the data to the database.
void	SetDefaultIapIspL (TUint32 aUid)
	Sets the default IAP & ISP records in Global Settings.
void	RemoveWapBearerApL (TUint32 aUid)
	Removes the WAP_BEARER table part of the access point from the database.
void	RemoveWapApL (TUint32 aUid)
	Removes the WAP_ACCESS_POINT table part of the access point from the database.
void	RemoveIapL (TUint32 aUid)
	Removes the IAP part of the access point from the database.
void	RemoveIspL (TUint32 aUid, TBool aOut)
	Removes the ISP part of the access point from the database.
void	RemoveGprsL (TUint32 aUid, TBool aOut)
	Removes the GPRS part of the access point from the database.
void	RemoveCdmaL (TUint32 aUid)
	Removes the CDMA part of the access point from the database.
void	RemoveLanL (TUint32 aUid)
	Removes the LAN part of the access point from the database.
void	RemoveWlanL (TUint32 aUid)
	Removes the WLAN part of the access point from the database.
TBool	HandleBearerChangeIfNeededL (CApAccessPointItem &aApItem)
	Handles the bearer change related things (deleting old links, inserting new ones if needed in the database).
void	DoAccessPointDataL (TUint32 aUid, CApAccessPointItem &aApItem)
	Reads up one access point's data from the database.
void	DoRemoveAPL (TUint32 aUid)
	Removes the given access point from the database.
void	DoSetAsDefaultL (TUint32 aUid, TCommsDbIspType aIntendedType)
	Sets the default access point.
void	DoSetPreferredIfDbIapTypeL (TUint32 aRank, TCommDbConnectionDirection aDirection, TUint32 aBearers, TCommDbDialogPref aPrompt, TUint32 aIAP, TBool aOverwrite)
	Sets the access point preference.
void	DoSetPreferredIfDbIspTypeL (TUint32 aRank, TCommDbConnectionDirection aDirection, TUint32 aBearers, TCommDbDialogPref aPrompt, TUint32 aISP, TUint32 aChargeCard, const TDesC &aServiceType, TBool aOverwrite)
	Sets the access point preference.
void	ApSpeed2EtelL (CApAccessPointItem *aItem)
	Converts setted AP speed from TApCallSpeed to commsdb values.
void	EtelSpeed2ApL (CApAccessPointItem &aItem)
	Converts commsdb speed values to TApCallSpeed.
TUint32	DoGetDefaultL (TBool aIsWap, TBool *aReadOnly) const
	Reads the UID of the default access point.
void	WriteProxyDataL (TBool aIsNew, const CApAccessPointItem &aApItem)
	Writes the proxy data of an access point.
void	ReadProxyDataL (CApAccessPointItem &aApItem)
	Reads up the proxy data of an access point.
void	RemoveProxyDataL (HBufC *aServiceType, TUint32 aIspId)
	Removes a proxy data.
void	WriteNetworkDataL (TBool aIsNew, CApAccessPointItem &aApItem)
	Writes the network data of an access point.
void	ReadNetworkDataL (CApAccessPointItem &aApItem)
	Reads up the network data of an access point.
void	RemoveNetworkDataL (TUint32 aIspId)
	Removes the network data.
TUint32	GetLocationIdL ()
	Gets the location record ID.
TUint32	GetModemBearerIDL (CApAccessPointItem &aApItem)
	Gets the modem record ID.
TUint32	ProtocolL (CApAccessPointItem &aApItem)
	Returns the protocol for the passed item.
TUint32	CommsDbSpeedL (CApAccessPointItem &aApItem)
	Returns the commsdb speed for the passed item.
void	ReadServiceL (CCommsDbTableView &ispt, CApAccessPointItem &aApItem)
	Reads up common IP & PPP SERVICE data parts of an access point.
void	ReadServiceIp6L (CCommsDbTableView &ispt, CApAccessPointItem &aApItem)
	Reads up CSD/GPRS IPv6 parts of an access point.
void	WriteServiceL (CCommsDbTableView &aTable, CApAccessPointItem &aApItem)
	Writes common IP & PPP SERVICE data parts of an access point.
void	WriteServiceIp6L (CCommsDbTableView &ispt, CApAccessPointItem &aApItem)
	Writes the IPv6 parts of an access point.
void	WriteCsdDataL (TBool aIsNew, CApAccessPointItem &aApItem)
	Writes the CSD isp data to the database.
void	ReadWlanL (CCommsDbTableView &lant, CApAccessPointItem &aApItem)
	Reads up WLAN data parts of an access point.
void	WriteWlanL (CCommsDbTableView &aTable, CApAccessPointItem &aApItem)
	Writes the WLAN parts of an access point.
TUint32	CreateLanBearerIfNeededL ()
	Creates a new record in the LANBearer table if there is none for WLAN.
void	ReadModemBearerNameL (CApAccessPointItem &aApItem)
	Reads up the name of the LAN/Modem bearer record.

Constructor & Destructor Documentation

virtual IMPORT_C CApDataHandler::~CApDataHandler ( ) [virtual]

Destructor.

Deprecated:

IMPORT_C CApDataHandler::CApDataHandler ( ) [protected]

C++ default constructor.

Deprecated:

Member Function Documentation

IMPORT_C void CApDataHandler::AccessPointDataL	(	TUint32	aUid,
		CApAccessPointItem &	aApItem
	)

Reads up one access point's data from the database.

Expects that CApDataHandler has been created and the database had been opened. In case of error, function leaves with error code.
Error conditions:

Insufficient memory,
AP does not exists,
Server connection failure.

Parameters:

	aUid	The Uid of the access point to be read
	aApItem	A reference to a CApAccessPointItem to hold the data.

Returns:: no return value.

Deprecated:

void CApDataHandler::ApSpeed2EtelL ( CApAccessPointItem * aItem ) [protected]

Converts setted AP speed from TApCallSpeed to commsdb values.

Parameters:

The

access point item whose speed needs to be converted

Returns:: no return value

TUint32 CApDataHandler::CommsDbSpeedL ( CApAccessPointItem & aApItem ) [protected]

Returns the commsdb speed for the passed item.

Parameters:

aApItem

An access point item

Returns:: The speed of the passed item.

IMPORT_C void CApDataHandler::ConstructL ( CCommsDatabase & aDb ) [protected]

Second-phase constructor.

Deprecated:

IMPORT_C TUint32 CApDataHandler::CreateCopyFromL

(

TUint32

aBaseId

)

Creates a copy of a previously existing access point.

Expects that CApDataHandler has been created and the database had been opened. In case of error, no access point will be created.
Error conditions:

Insufficient memory
Server connection failure.
Lock already present by other task.
Access point does not exist.
Attempting to create new in protected tables will results in KErrAccessDenied

Parameters:

aBaseId

The UID of the existing access point to copy from.

Returns:: The Uid of the newly constructed and saved access point.

Deprecated:

IMPORT_C TUint32 CApDataHandler::CreateFromDataL

(

CApAccessPointItem &

aApItem

)

Create a new access point from supplied data Expects that CApDataHandler has been created and the database had been opened.

The name of the AP will be corrected to be unique if necessary and returned in the passed aApItem. In case of error, no access point will be created and the passed one will remain intact.
Error conditions:

Insufficient memory
Server connection failure.
Lock already present by other task.
Attempting to create new in protected tables will result in KErrAccessDenied

Parameters:

aApItem

Reference to a CApAccessPointItem holding the data

Returns:: The UID of the newly created and saved access point.

Deprecated:

TUint32 CApDataHandler::CreateLanBearerIfNeededL ( ) [protected]

Creates a new record in the LANBearer table if there is none for WLAN.

Returns:: The UID of the LANBEarer record.

IMPORT_C void CApDataHandler::CreateNetworkL

(

CApNetworkItem &

aNetwork

)

Creates a network group from the data.

Expects that CApDataHandler has been created and the database had been opened. In case of error, network group will not be created.
Error conditions:

Insufficient memory,
Server connection failure.
Lock already present by other task.
network group does not exist.
Attempting to remove read-only records will result in KErrAccessDenied

Parameters:

aNetwork

The network item to create/write into db.

Returns:: no return value.

Deprecated:

IMPORT_C TUint32 CApDataHandler::DefaultL	(	TBool	aIsWap,
		TBool &	aReadOnly
	)	const

Reads the UID of the default access point.

Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes.
Error conditions:

Insufficient memory;
Server connection failure;
Lock already present;
Access point does not exists.

Parameters:

	aIsWAP	A boolean indicating whether to read the default WAP or the default IAP/ISP (dep. on the database type) access point.
	aReadOnly	A TBool passed by reference to hold whether the the default access point record is read-only or not.

Returns:: The UID of the default access point.

Deprecated:

IMPORT_C TUint32 CApDataHandler::DefaultL

(

TBool

aIsWap

)

const

Reads the UID of the default access point.

Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes.
Error conditions:

Insufficient memory;
Server connection failure;
Lock already present;
Access point does not exists.

Parameters:

aIsWAP

A boolean indicating whether to read the default WAP or the default IAP/ISP (dep. on the database type) access point.

Returns:: The UID of the default access point.

Deprecated:

void CApDataHandler::DoAccessPointDataL	(	TUint32	aUid,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Reads up one access point's data from the database.

Expects that CApDataHandler has been created and the database had been opened. In case of error, function leaves with error code.
Error conditions:

Insufficient memory,
AP does not exists,
Server connection failure.

Parameters:

	aUid	The Uid of the access point to be read
	aApItem	A reference to a CApAccessPointItem to hold the data.

Returns:: no return value.

TUint32 CApDataHandler::DoGetDefaultL	(	TBool	aIsWap,
		TBool *	aReadOnly
	)	const `[protected]`

Reads the UID of the default access point.

Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes.
Error conditions:

Insufficient memory;
Server connection failure;
Lock already present;
Access point does not exists.

Parameters:

	aIsWAP	A boolean indicating whether to read the default WAP or the default IAP/ISP (dep. on the database type) access point.
	TBool,:*	if not NULL, a holder for the read-only flag of the default access point. Prepared for future products but also used here through passing NULL ptr.

Returns:: The UID of the default access point.

void CApDataHandler::DoRemoveAPL ( TUint32 aUid ) [protected]

Removes the given access point from the database.

Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.
Error conditions:

Insufficient memory,
Server connection failure.
Lock already present by other task.
Access point does not exist.
Attempting to remove read-only records will result in KErrAccessDenied

Parameters:

aUid

The UID of the access point to remove.

Returns:: no return value.

void CApDataHandler::DoSetAsDefaultL	(	TUint32	aUid,
		TCommsDbIspType	aIntendedType
	)	`[protected]`

Sets the default access point.

Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes.
Error conditions:

Insufficient memory;
Server connection failure;
Lock already present;
Access point does not exists.
Given Access Point is not of the desired type.

Parameters:

	aUid	The UID of the access point to be set as default.
	aIntendedType	The default type ( IAP, WAP, Both).

void CApDataHandler::DoSetPreferredIfDbIapTypeL	(	TUint32	aRank,
		TCommDbConnectionDirection	aDirection,
		TUint32	aBearers,
		TCommDbDialogPref	aPrompt,
		TUint32	aIAP,
		TBool	aOverwrite
	)	`[protected]`

Sets the access point preference.

Can be used only if the database type is IAP. Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes.
Error conditions:

Insufficient memory;
Server connection failure;

Lock already present; Can also leave with KErrAlreadyExists (if aOverWrite is EFalse ).

Parameters:

	aRank	The ranking of the connection preference.
	aDircetion	Specifies the direction of this connection preference
	aBearers	The bearer set beeing valid for this connection preference
	aPrompt	Enum value indicating whether or not the user should be prompted or warned on connection
	aIAP	The identifier of the preferred IAP for this connection.
	aOverwrite	Boolean value indicating that if a same record present, overwrite it or not.

void CApDataHandler::DoSetPreferredIfDbIspTypeL	(	TUint32	aRank,
		TCommDbConnectionDirection	aDirection,
		TUint32	aBearers,
		TCommDbDialogPref	aPrompt,
		TUint32	aISP,
		TUint32	aChargeCard,
		const TDesC &	aServiceType,
		TBool	aOverwrite
	)	`[protected]`

Sets the access point preference.

Can be used only if the database type is ISP. Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes.
Error conditions:

Insufficient memory;
Server connection failure;

Lock already present; Can also leave with KErrAlreadyExists (if aOverWrite is EFalse ).

Parameters:

	aRank	The ranking of the connection preference.
	aDircetion	Specifies the direction of this connection preference
	aBearers	The bearer set beeing valid for this connection preference
	aPrompt	Enum value indicating whether or not the user should be prompted or warned on connection
	aISP	The identifier of the preferred ISP for this connection.
	aChargeCard	Identifier of the preferred chargecard for this connection.
	aServiceType	The type of the service.
	aOverwrite	Boolean value indicating that if a same record present, overwrite it or not.

TUint32 CApDataHandler::DoUpdateAccessPointDataL	(	CApAccessPointItem &	aApItem,
		TBool	aIsNew,
		TBool &	aNameChanged
	)	`[protected]`

Writes the data to the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aApItem	Reference to a CApAccessPointItem which holds the data
	aIsNew	A Boolean indicating whether it is a new record or it is an update operation.

Returns:: No return value.

void CApDataHandler::EtelSpeed2ApL ( CApAccessPointItem & aItem ) [protected]

Converts commsdb speed values to TApCallSpeed.

Parameters:

The

access point item whose speed needs to be converted

Returns:: no return value

TUint32 CApDataHandler::GetLocationIdL ( ) [protected]

Gets the location record ID.

Returns:: The UID of the location.

TUint32 CApDataHandler::GetModemBearerIDL ( CApAccessPointItem & aApItem ) [protected]

Gets the modem record ID.

Returns:: The UID of the modem record.

IMPORT_C void CApDataHandler::GetPreferredIfDbIapTypeL	(	TUint32	aRank,
		TCommDbConnectionDirection	aDirection,
		TUint32 &	aBearers,
		TUint32 &	aPrompt,
		TUint32 &	aIAP
	)

Gets the access point preference.

Insufficient memory;
Server connection failure;

Lock already present;

Parameters:

	aRank	The ranking of the desired connection preference.
	aDircetion	Specifies the direction of the desired connection preference
	aBearers	The bearer set beeing valid for this connection preference
	aPrompt	Enum value indicating whether or not the user should be prompted or warned on connection
	aIAP	The identifier of the preferred IAP for this connection preference.

Deprecated:

IMPORT_C const TDesC& CApDataHandler::GetPreferredIfDbIspTypeL	(	TUint32	aRank,
		TCommDbConnectionDirection	aDirection,
		TUint32 &	aBearers,
		TUint32 &	aPrompt,
		TUint32 &	aISP,
		TUint32 &	aChargeCard
	)

Gets the access point preference.

Insufficient memory;
Server connection failure;

Lock already present;

Parameters:

	aRank	The ranking of the desired connection preference.
	aDircetion	Specifies the direction of the desired connection preference
	aBearers	The bearer set beeing valid for this connection preference
	aPrompt	Enum value indicating whether or not the user should be prompted or warned on connection
	aISP	The identifier of the preferred ISP for this connection preference.
	aChargeCard	Identifier of the preferred chargecard for this connection preference.

Returns:: The type of the service.

Deprecated:

TBool CApDataHandler::HandleBearerChangeIfNeededL ( CApAccessPointItem & aApItem ) [protected]

Handles the bearer change related things (deleting old links, inserting new ones if needed in the database).

Expects that CApDataHandler has been created and the database had been opened. In case of error, access point data will not be changed.

Parameters:

aApItem

A reference to a CApAccessPointItem holding the CHANGED data.

Returns:: Boolean indicating whether bearer has changed or not.

static IMPORT_C CApDataHandler* CApDataHandler::NewLC ( CCommsDatabase & aDb ) [static]

Two-phased constructor.

Leaves on failure, places instance on cleanup stack.

Parameters:

aDb

a reference to a CCommsDataBase object.

Returns:: The constructed CApDataHandler.

Deprecated:

TUint32 CApDataHandler::ProtocolL ( CApAccessPointItem & aApItem ) [protected]

Returns the protocol for the passed item.

Parameters:

aApItem

An access point item

Returns:: The protocol of the passed item.

void CApDataHandler::ReadCdmaDataL	(	TUint32	aIspId,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Reads the CDMA data from the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aIspId	The UID of the record in the CDMA table to read the data from.
	aApItem	A reference to a CApAccessPointItem to hold the data

Returns:: No return value.

void CApDataHandler::ReadDialInOutDataL	(	TUint32	aIspId,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Reads the DialIn/Out ISP data from the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aIspId	The UID of the record in the Dialup table to read the data from.
	aApItem	A reference to a CApAccessPointItem to hold the data

Returns:: No return value.

void CApDataHandler::ReadGprsDataL	(	TUint32	aIspId,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Reads the GPRS data from the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aIspId	The UID of the record in the GPRS table to read the data from.
	aApItem	A reference to a CApAccessPointItem to hold the data

Returns:: No return value.

void CApDataHandler::ReadIapDataL	(	TUint32	aIapId,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Reads the IAP part of the data from the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aIapId	The UID of the record in the IAP table to read the data.
	aApItem	A reference to a CApAccessPointItem to hold the data

Returns:: No return value.

void CApDataHandler::ReadIspDataL	(	TUint32	aIspId,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Reads the ISP part of the data from the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aIspId	The UID of the record in the ISP table to read the data.
	aApItem	A reference to a CApAccessPointItem to hold the data

Returns:: No return value.

void CApDataHandler::ReadLanDataL	(	TUint32	aIspId,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Reads the LAN data from the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aIspId	The UID of the record in the LAN table to read the data from.
	aApItem	A reference to a CApAccessPointItem to hold the data

Returns:: No return value.

void CApDataHandler::ReadModemBearerNameL ( CApAccessPointItem & aApItem ) [protected]

Reads up the name of the LAN/Modem bearer record.

void CApDataHandler::ReadNetworkDataL ( CApAccessPointItem & aApItem ) [protected]

Reads up the network data of an access point.

Parameters:

aApItem

A CApAccessPointItem passed by reference holding the current access point data.

IMPORT_C void CApDataHandler::ReadNetworkL	(	TUint32	aUid,
		CApNetworkItem &	aNetwork
	)

Reads up a network Network is identified by passed uid.

Deprecated:

IMPORT_C void CApDataHandler::ReadNetworkPartL

(

CApAccessPointItem &

aItem

)

Reads up a network part of the access point Network is identified by the iNetworkId of the passed access point.

Deprecated:

void CApDataHandler::ReadProxyDataL ( CApAccessPointItem & aApItem ) [protected]

Reads up the proxy data of an access point.

Parameters:

aApItem

A CApAccessPointItem passed by reference holding the current access point data.

void CApDataHandler::ReadServiceIp6L	(	CCommsDbTableView &	ispt,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Reads up CSD/GPRS IPv6 parts of an access point.

Leaves if it is not persent in the database

Parameters:

	The	table to read from
	The	CApAccessPointItem to store into

void CApDataHandler::ReadServiceL	(	CCommsDbTableView &	ispt,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Reads up common IP & PPP SERVICE data parts of an access point.

Leaves if it is not persent in the database

Parameters:

	The	table to read from
	The	CApAccessPointItem to store into

void CApDataHandler::ReadVpnInfoL	(	TUint32	aIspId,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Reads up the VPN bearer type info in case of a VPN access point In case of error, leaves with CommDb error codes.

Parameters:

	aIspId	The UID of the record in the VPN table to read the data from.
	aApItem	A reference to a CApAccessPointItem to hold the data

Returns:: No return value.

void CApDataHandler::ReadWapDataL	(	TUint32	aWapId,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Reads the WAP part of the data from the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aWapId	The UID of the Access Point to read the data from.
	aApItem	A reference to a CApAccessPointItem to hold the data

Returns:: No return value.

void CApDataHandler::ReadWlanL	(	CCommsDbTableView &	lant,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Reads up WLAN data parts of an access point.

Leaves if it is not persent in the database

Parameters:

	The	table to read from
	The	CApAccessPointItem to store into

IMPORT_C void CApDataHandler::RemoveAPL

(

TUint32

aUid

)

Removes the given access point from the database.

Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.
Error conditions:

Insufficient memory,
Server connection failure.
Lock already present by other task.
Access point does not exist.
Attempting to remove read-only records will result in KErrAccessDenied

Parameters:

aUid

The UID of the access point to remove.

Returns:: no return value.

Deprecated:

void CApDataHandler::RemoveCdmaL ( TUint32 aUid ) [protected]

Removes the CDMA part of the access point from the database.

Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameters:

aUid

The UID of the CDMA part of the access point to remove.

Returns:: No return value.

void CApDataHandler::RemoveGprsL	(	TUint32	aUid,
		TBool	aOut
	)	`[protected]`

Removes the GPRS part of the access point from the database.

Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameters:

aUid

The UID of the GPRS part of the access point to remove.

Returns:: No return value.

void CApDataHandler::RemoveIapL ( TUint32 aUid ) [protected]

Removes the IAP part of the access point from the database.

Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameters:

aUid

The UID of the IAP part of the access point to remove.

Returns:: No return value.

void CApDataHandler::RemoveIspL	(	TUint32	aUid,
		TBool	aOut
	)	`[protected]`

Removes the ISP part of the access point from the database.

Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameters:

	aUid	The UID of the ISP part of the access point to remove.
	aOut	TBool indicating whether Dial out or dial in ISP.

Returns:: No return value.

void CApDataHandler::RemoveLanL ( TUint32 aUid ) [protected]

Removes the LAN part of the access point from the database.

Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameters:

aUid

The UID of the LAN part of the access point to remove.

Returns:: No return value.

void CApDataHandler::RemoveNetworkDataL ( TUint32 aIspId ) [protected]

Removes the network data.

Parameters:

aIspId

The record ID to remove

IMPORT_C void CApDataHandler::RemoveNetworkL

(

TUint32

aUid

)

Removes the given network group from the database.

Expects that CApDataHandler has been created and the database had been opened. In case of error, network group will not be removed.
Error conditions:

Insufficient memory,
Server connection failure.
Lock already present by other task.
network group does not exist.
Attempting to remove read-only records will result in KErrAccessDenied

Parameters:

aUid

The UID of the network group to remove.

Returns:: no return value.

Deprecated:

void CApDataHandler::RemoveProxyDataL	(	HBufC *	aServiceType,
		TUint32	aIspId
	)	`[protected]`

Removes a proxy data.

Parameters:

	aServiceType	The service type to remove for
	aIspId	The service record ID

void CApDataHandler::RemoveWapApL ( TUint32 aUid ) [protected]

Removes the WAP_ACCESS_POINT table part of the access point from the database.

Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameters:

aUid

The UID of the access point to remove.

Returns:: No return value.

void CApDataHandler::RemoveWapBearerApL ( TUint32 aUid ) [protected]

Removes the WAP_BEARER table part of the access point from the database.

Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameters:

aUid

The UID of the access point to remove.

Returns:: No return value.

void CApDataHandler::RemoveWlanL ( TUint32 aUid ) [protected]

Removes the WLAN part of the access point from the database.

Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameters:

aUid

The UID of the LAN part of the access point to remove.

Returns:: No return value.

IMPORT_C void CApDataHandler::SetAsDefaultL	(	TUint32	aUid,
		TCommsDbIspType	aIntendedType
	)

Sets the default access point.

Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes.
Error conditions:

Insufficient memory;
Server connection failure;
Lock already present;
Access point does not exists.
Given Access Point is not of the desired type.

Parameters:

	aUid	The UID of the access point to be set as default.
	aIntendedType	The default type ( IAP, WAP, Both).

Deprecated:

void CApDataHandler::SetDefaultIapIspL ( TUint32 aUid ) [protected]

Sets the default IAP & ISP records in Global Settings.

In case of error, leaves with CommDb error codes.

Parameters:

aApItem

A UID to the WAP Access Point record to be used as a default.

Returns:: No return value.

IMPORT_C void CApDataHandler::SetPreferredIfDbIapTypeL	(	TUint32	aRank,
		TCommDbConnectionDirection	aDirection,
		TUint32	aBearers,
		TCommDbDialogPref	aPrompt,
		TUint32	aIAP,
		TBool	aOverwrite
	)

Sets the access point preference.

Insufficient memory;
Server connection failure;

Lock already present; Can also leave with KErrAlreadyExists (if aOverWrite is EFalse ).

Parameters:

	aRank	The ranking of the connection preference.
	aDircetion	Specifies the direction of this connection preference
	aBearers	The bearer set being valid for this connection preference
	aPrompt	Enum value indicating whether or not the user should be prompted or warned on connection
	aIAP	The identifier of the preferred IAP for this connection.
	aOverwrite	Boolean value indicating that if a same record present, overwrite it or not.

Deprecated:

IMPORT_C void CApDataHandler::SetPreferredIfDbIspTypeL	(	TUint32	aRank,
		TCommDbConnectionDirection	aDirection,
		TUint32	aBearers,
		TCommDbDialogPref	aPrompt,
		TUint32	aISP,
		TUint32	aChargeCard,
		const TDesC &	aServiceType,
		TBool	aOverwrite
	)

Sets the access point preference.

Insufficient memory;
Server connection failure;

Lock already present; Can also leave with KErrAlreadyExists (if aOverWrite is EFalse ).

Parameters:

	aRank	The ranking of the connection preference.
	aDircetion	Specifies the direction of this connection preference
	aBearers	The bearer set beeing valid for this connection preference
	aPrompt	Enum value indicating whether or not the user should be prompted or warned on connection
	aISP	The identifier of the preferred ISP for this connection.
	aChargeCard	Identifier of the preferred chargecard for this connection.
	aServiceType	The type of the service.
	aOverwrite	Boolean value indicating that if a same record is present, overwrite it or not.

Deprecated:

IMPORT_C void CApDataHandler::UpdateAccessPointDataL	(	CApAccessPointItem &	aApItem,
		TBool &	aNameChanged
	)

Updates data stored in an existing access point.

Expects that CApDataHandler has been created and the database had been opened. In case of error, no data is stored.
Error conditions:

Insufficient memory
Server connection failure
Lock already present by other task
Uid does not exists.
Attempting to update read-only records will result in KErrAccessDenied

Parameters:

	aApItem	A reference to a CApAccessPointItem holding the data
	aNameChanged	a reference to a TBool that will indicate whether the name has changed or not.

Returns:: No return value.

Deprecated:

void CApDataHandler::WriteCdmaDataL	(	TBool	aIsNew,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Writes the Cdma data to the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aIsNew	A Boolean indicating whether it is a new record or it is an update operation.
	aApItem	Reference to a CApAccessPointItem which holds the data

Returns:: No return value.

void CApDataHandler::WriteCsdDataL	(	TBool	aIsNew,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Writes the CSD isp data to the database.

In case of error, leaves with CommDb error codes. Leaves with KErrNotSupported if (HS)CSD bearer type is not supported.

Parameters:

	aIsNew	A Boolean indicating whether it is a new record or it is an update operation.
	aApItem	Reference to a CApAccessPointItem which holds the data

Returns:: No return value.

void CApDataHandler::WriteGprsDataL	(	TBool	aIsNew,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Writes the Gprs data to the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aIsNew	A Boolean indicating whether it is a new record or it is an update operation.
	aApItem	Reference to a CApAccessPointItem which holds the data

Returns:: No return value.

void CApDataHandler::WriteIapDataL	(	TBool	aIsNew,
		TUint32	aIapId,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Writes the IAP part of the data to the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aIsNew	A Boolean indicating whether it is a new record or it is an update operation.
	aIapId	The UID of the IAP Access Point record to update. Used only if aIsNew EFalse.
	aApItem	Reference to a CApAccessPointItem which holds the data

Returns:: No return value.

void CApDataHandler::WriteIspDataL	(	TBool	aIsNew,
		TUint32	aIspId,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Writes the ISP part of the data to the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aIsNew	A Boolean indicating whether it is a new record or it is an update operation.
	aIspId	The UID of the ISP Access Point record to update. Used only if aIsNew EFalse.
	aApItem	Reference to a CApAccessPointItem which holds the data

Returns:: No return value.

void CApDataHandler::WriteLanDataL	(	TBool	aIsNew,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Writes the LAN data to the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aIsNew	A Boolean indicating whether it is a new record or it is an update operation.
	aApItem	Reference to a CApAccessPointItem which holds the data

Returns:: No return value.

void CApDataHandler::WriteNetworkDataL	(	TBool	aIsNew,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Writes the network data of an access point.

Parameters:

	aIsNew	Boolean stating whether the access point is new
	aApItem	A CApAccessPointItem passed by reference holding the current access point data. It's record ID's will be updated if needed (in case it is a new item )

void CApDataHandler::WriteProxyDataL	(	TBool	aIsNew,
		const CApAccessPointItem &	aApItem
	)	`[protected]`

Writes the proxy data of an access point.

Parameters:

	aIsNew	Boolean stating whether the access point is new
	aApItem	A CApAccessPointItem passed by reference holding the current access point data. It's record ID's will be updated if needed (in case it is a new item )

void CApDataHandler::WriteServiceIp6L	(	CCommsDbTableView &	ispt,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Writes the IPv6 parts of an access point.

Leaves if it is not persent in the database

Parameters:

	The	table to write to
	The	CApAccessPointItem to read the data from

void CApDataHandler::WriteServiceL	(	CCommsDbTableView &	aTable,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Writes common IP & PPP SERVICE data parts of an access point.

Leaves if it is not persent in the database

Parameters:

	The	table to write into
	The	CApAccessPointItem holding the data to store

void CApDataHandler::WriteWapApDataL	(	TBool	aIsNew,
		TUint32	aWapId,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Writes the WAP AP part of the data to the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aIsNew	A Boolean indicating whether it is a new record or it is an update operation.
	aWapId	The UID of the WAP Access Point record to update. Used only if aIsNew EFalse.
	aApItem	Reference to a CApAccessPointItem which holds the data

Returns:: No return value.

void CApDataHandler::WriteWapBearerDataL	(	TBool	aIsNew,
		TUint32	aWapId,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Writes the WAP bearer part of the data to the database.

In case of error, leaves with CommDb error codes.

Parameters:

	aIsNew	A Boolean indicating whether it is a new record or it is an update operation.
	aWapId	The UID of the WAP Access Point record to update. Used only if aIsNew EFalse.
	aApItem	Reference to a CApAccessPointItem which holds the data

Returns:: No return value.

void CApDataHandler::WriteWlanL	(	CCommsDbTableView &	aTable,
		CApAccessPointItem &	aApItem
	)	`[protected]`

Writes the WLAN parts of an access point.

Leaves if it is not persent in the database

Parameters:

	The	table to write to
	The	CApAccessPointItem to read the data from

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

apdatahandler.h

CApDataHandler Class Reference

Capability Information

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation