CApAccessPointItem Class Reference

#include <mw/ApAccessPointItem.h>

Link against: APEngine.lib

class CApAccessPointItem : public CBase

Inherits from

CApAccessPointItem

Public Member Functions
virtual	~CApAccessPointItem()
IMPORT_C TApBearerType	BearerTypeL()
IMPORT_C const TDesC &	ConnectionName()
IMPORT_C void	CopyFromL(const CApAccessPointItem &)
IMPORT_C TBool	HasSameIspAndBearerL(CApAccessPointItem &)
IMPORT_C TBool	IsReadOnly()
TBool	IsVpnAp()
IMPORT_C CApAccessPointItem *	NewLC()
IMPORT_C TInt	ReadBool(const TApMember, TBool &)
IMPORT_C const HBufC *	ReadConstLongTextL(const TApMember)
IMPORT_C HBufC *	ReadLongTextL(const TApMember)
IMPORT_C void	ReadTextL(const TApMember, TDes8 &)
IMPORT_C void	ReadTextL(const TApMember, TDes16 &)
IMPORT_C TUint32	ReadTextLengthL(const TApMember)
IMPORT_C TInt	ReadUint(const TApMember, TUint32 &)
IMPORT_C TBool	SanityCheckOk()
IMPORT_C void	SetBearerTypeL(TApBearerType)
IMPORT_C void	SetNamesL(const TDesC16 &)
void	SetVpnAp(TBool)
IMPORT_C const TDesC &	WapBearer()
IMPORT_C TUint32	WapUid()
IMPORT_C TInt	WriteBool(const TApMember, const TBool &)
IMPORT_C TInt	WriteLongTextL(const TApMember, const TDesC &)
IMPORT_C TInt	WriteTextL(const TApMember, const TDesC8 &)
IMPORT_C TInt	WriteTextL(const TApMember, const TDesC16 &)
IMPORT_C TInt	WriteUint(const TApMember, const TUint32 &)
IMPORT_C TBool	operator!=(const CApAccessPointItem &)
IMPORT_C TBool	operator==(const CApAccessPointItem &)

Protected Member Functions
	CApAccessPointItem()
IMPORT_C void	ConstructL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

CApAccessPointItem is used to exchange data between engine and client. It holds the information for an access point including WAP, IAP, ISP (if present & applies). This class uses the same approach as CommDB to read and write data: it has functions for each data type implemented. To read or write the data, we have to know the data type and the enum name of the 'column'. The column values has the names of the database columns with the 'EAp' prefix. The reason for this (not using the database column descriptors) is performance. It is much faster to compare enum values than literals.

Constructor & Destructor Documentation

CApAccessPointItem ( )

IMPORT_C

CApAccessPointItem

(

)

[protected]

C++ default constructor.

Deprecated

~CApAccessPointItem ( )

IMPORT_C

~CApAccessPointItem

(

)

[virtual]

Destructor.

Deprecated

Member Function Documentation

BearerTypeL ( )

IMPORT_C TApBearerType

BearerTypeL

(

)

This function returns the bearer type for the current access point Deprecated

Returns: The current bearer type for the access point

ConnectionName ( )

IMPORT_C const TDesC &

ConnectionName

(

)

const

This function returns the name of the connection Ownership is not passed. Deprecated

Returns: The name of the connection

ConstructL ( )

IMPORT_C void

ConstructL

(

)

[protected]

Second-phase constructor.

Deprecated

CopyFromL ( const CApAccessPointItem & )

IMPORT_C void

CopyFromL

(

const CApAccessPointItem &

aCopyFrom

)

Copies the data from another CApAccessPointItem. Substitute for the "assignment operator". It requires allocation thus can leave. Wap Access Point Uid is not copied.

Deprecated

HasSameIspAndBearerL ( CApAccessPointItem & )

IMPORT_C TBool

HasSameIspAndBearerL

(

CApAccessPointItem &

aItem

)

This function compares this and the passed CApAccessPointItem whether they have the same ISP and bearer Returns true if the APs have the same phone number Deprecated

Parameter	Description
aItem	a CApAccessPointItem to compare with

Returns: whether the APs have the same isp and bearer

IsReadOnly ( )

IMPORT_C TBool

IsReadOnly

(

)

const

This function returns whether the access point is read-only or not. Deprecated

Returns: Whether the current access point is read-only or not.

IsVpnAp ( )

TBool

IsVpnAp

(

)

const

Returnes whether the given access point is a VPN ap or not.

NewLC ( )

IMPORT_C CApAccessPointItem *

NewLC

(

)

[static]

Two-phased constructor. Leaves on failure, places instance on cleanup stack. Instance is initialised to default values. The created instance is suitable for passing to CApDataHandler's functions, contains all necessary information. Deprecated

Returns: The constructed CApAccessPointItem.

ReadBool ( const TApMember, TBool & )

IMPORT_C TInt	ReadBool	(	const TApMember	aColumn,
			TBool &	aValue
		)

This function reads up a boolean value from the specified column. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation. Deprecated

Parameter	Description
aColumn	Enum value indicating the column to read.
aValue	A reference to a boolean to hold the value

Returns: Error code.

ReadConstLongTextL ( const TApMember )

IMPORT_C const HBufC *

ReadConstLongTextL

(

const TApMember

aColumn

)

This function reads up a long text value from the specified column. The ownership is not passed to the caller. It means that the caller should not delete the received value. If the caller must take the ownership for any reason, must make a copy and use that and delete the copy when no longer needed. Deprecated

Parameter	Description
aColumn	Enum value indicating the column to read.

Returns: A const HBufC* to the value.

ReadLongTextL ( const TApMember )

IMPORT_C HBufC *

ReadLongTextL

(

const TApMember

aColumn

)

NOTE: This function is deprecated. Use ReadConstLongTextL! This function reads up a long text value from the specified column. The ownership is not passed to the caller. It means that the caller should not delete the received value. If the caller must take the ownership for any reason, must make a copy and use that and delete the copy when no longer needed. Deprecated

Parameter	Description
aColumn	Enum value indicating the column to read.

Returns: A HBufC* to the value.

ReadTextL ( const TApMember, TDes8 & )

IMPORT_C void	ReadTextL	(	const TApMember	aColumn,
			TDes8 &	aValue
		)

This function reads up an 8-bit text value from the specified column. Deprecated

Parameter	Description
aColumn	Enum value indicating the column to read.
aValue	Reference to an 8-bit descriptor to hold the value

Returns: no return value

ReadTextL ( const TApMember, TDes16 & )

IMPORT_C void	ReadTextL	(	const TApMember	aColumn,
			TDes16 &	aValue
		)

This function reads up a 16-bit text value from the specified column. Deprecated

Parameter	Description
aColumn	Enum value indicating the column to read.
aValue	Reference to a 16-bit descriptor to hold the value

Returns: no return value

ReadTextLengthL ( const TApMember )

IMPORT_C TUint32

ReadTextLengthL

(

const TApMember

aColumn

)

This function reads the length of the text in the specified column. Deprecated

Parameter	Description
aColumn	Enum value indicating the column to read.

Returns: The length of the text in that column.

ReadUint ( const TApMember, TUint32 & )

IMPORT_C TInt	ReadUint	(	const TApMember	aColumn,
			TUint32 &	aValue
		)

This function reads up a TUint32 value from the specified column. In case the given value was not written to the database, it will return KErrValueUnspecified. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation. Deprecated

Parameter	Description
aColumn	Enum value indicating the column to read.
aValue	A reference to a TUint32 to hold the value

Returns: Error code.

SanityCheckOk ( )

IMPORT_C TBool

SanityCheckOk

(

)

This function checks the integrity of the CApAccessPointItem. Currently checks: IF WAP_IP_BEARER, WAP_ISP_TYPE conforms to IAP_SERVICE_TYPE Deprecated

Returns: Boolean indicating whether the sanity check has passed(ETrue) or not(EFalse)

SetBearerTypeL ( TApBearerType )

IMPORT_C void

SetBearerTypeL

(

TApBearerType

aBearer

)

This function sets the bearer type for the current access point Deprecated

Parameter	Description
aBearer	TApBearerType enum indicating the desired bearer type.

Returns: No return value.

SetNamesL ( const TDesC16 & )

IMPORT_C void

SetNamesL

(

const TDesC16 &

aValue

)

This function writes a 16-bit text value to the 'name' fields of the access point. This includes: WAP_ACCESS_POINT, IAP, Dial/in/out/Gprs In/Out table's COMM_DB_NAME fields. These fields are (by TApMember): EApWapAccessPointName, EApIapName, EApIspName. It is useful if we need to use same names. Deprecated

Parameter	Description
aValue	A const reference to a 16-bit text descriptor to the value.

Returns: No return value.

SetVpnAp ( TBool )

void

SetVpnAp

(

TBool

aIsVpn

)

Sets the current access point as VPN or as normal AP. Internal use only!

Parameter	Description
aIsVpn	a TBool specifiyng that the current AP is VPN or not.

WapBearer ( )

IMPORT_C const TDesC &

WapBearer

(

)

const

This function returns the current WAP bearer for the access point Ownership is not passed. Deprecated

Returns: The current WAP bearer for the access point

WapUid ( )

IMPORT_C TUint32

WapUid

(

)

const

This function returns the ID of the access point Deprecated

Returns: The ID of this access point

WriteBool ( const TApMember, const TBool & )

IMPORT_C TInt	WriteBool	(	const TApMember	aColumn,
			const TBool &	aValue
		)

This function writes a boolean value to the specified column. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation. Deprecated

Parameter	Description
aColumn	Enum value indicating the column to write.
aValue	A const reference to a boolean value

Returns: Error code.

WriteLongTextL ( const TApMember, const TDesC & )

IMPORT_C TInt	WriteLongTextL	(	const TApMember	aColumn,
			const TDesC &	aValue
		)

This function writes a long text value to the specified column. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation. This function can Leave if the copying of the text does not succeed. Deprecated

Parameter	Description
aColumn	Enum value indicating the column to write.
aValue	Reference to a 16-bit text descriptor to the value

Returns: Error code.

WriteTextL ( const TApMember, const TDesC8 & )

IMPORT_C TInt	WriteTextL	(	const TApMember	aColumn,
			const TDesC8 &	aValue
		)

This function writes an 8-bit text value to the specified column. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation. This function can Leave if the copying of the text does not succeed. Possible leave codes are the system leave codes. Deprecated

Parameter	Description
aColumn	Enum value indicating the column to write.
aValue	Reference to an 8-bit text descriptor to the value

Returns: Error code.

WriteTextL ( const TApMember, const TDesC16 & )

IMPORT_C TInt	WriteTextL	(	const TApMember	aColumn,
			const TDesC16 &	aValue
		)

This function writes a 16-bit text value to the specified column. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation. This function can Leave if the copying of the text does not succeed. Deprecated

Parameter	Description
aColumn	Enum value indicating the column to write.
aValue	Reference to a 16-bit text descriptor to the value

Returns: Error code.

WriteUint ( const TApMember, const TUint32 & )

IMPORT_C TInt	WriteUint	(	const TApMember	aColumn,
			const TUint32 &	aValue
		)

This function writes a TUint32 value to the specified column. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation. Deprecated