Collapse all Symbian^3 Product Developer Library

TDialLocation Class Reference

class TDialLocation

Contains information about the current location such as international prefix code, area code etc.

There are functions to get and set this information.

This class has been deprecated from 9.1 and should no longer be used.

Public Member Functions
	TDialLocation()
	TDialLocation(const TIntlPrefCode &, const TNatPrefCode &, const TNatCode &, const TAreaCode &, const TDialOutLocalCode &, const TDialOutLongDistanceCode &, const TDisableCallWaitingCode &, TUint, TUint)
IMPORT_C TPtrC	AreaCode()
void	ClearDialLocationFlags(TUint)
IMPORT_C TPtrC	DialOutLocalCode()
IMPORT_C TPtrC	DialOutLongDistanceCode()
IMPORT_C TPtrC	DisableCallWaitingCode()
IMPORT_C TPtrC	IntlPrefCode()
IMPORT_C TBool	IsDialOutRequired()
IMPORT_C TBool	IsDisableCallWaitingCode()
IMPORT_C TBool	IsMobile()
IMPORT_C TBool	IsPbxUsePulseDial()
TBool	IsReturnPhoneNumberWithPlusFormat()
IMPORT_C TBool	IsUsePulseDial()
IMPORT_C TBool	IsWaitForDialingTone()
IMPORT_C TBool	IsWaitForProceedTone()
IMPORT_C TPtrC	NatCode()
IMPORT_C TPtrC	NatPrefCode()
IMPORT_C TInt	PauseAfterDialout()
IMPORT_C void	SetAreaCode(const TDesC &)
IMPORT_C void	SetDialLocationFlags(TUint)
IMPORT_C void	SetDialOutLocalCode(const TDesC &)
IMPORT_C void	SetDialOutLongDistanceCode(const TDesC &)
IMPORT_C void	SetDisableCallWaitingCode(const TDesC &)
IMPORT_C void	SetIntlPrefCode(const TDesC &)
IMPORT_C void	SetNatCode(const TDesC &)
IMPORT_C void	SetNatPrefCode(const TDesC &)
IMPORT_C void	SetPauseAfterDialout(TUint)

Private Attributes
TAreaCode	iAreaCode
TDialOutLocalCode	iDialOutLocalCode
TDialOutLongDistanceCode	iDialOutLongDistanceCode
TDisableCallWaitingCode	iDisableCallWaitingCode
TUint	iFlags
TIntlPrefCode	iIntlPrefCode
TNatCode	iNatCode
TNatPrefCode	iNatPrefCode
TUint	iPauseAfterDialout

Constructor & Destructor Documentation

TDialLocation()

IMPORT_C

TDialLocation

(

)

Creates an empty TDialLocation. 9.1

TDialLocation(const TIntlPrefCode &, const TNatPrefCode &, const TNatCode &, const TAreaCode &, const TDialOutLocalCode &, const TDialOutLongDistanceCode &, const TDisableCallWaitingCode &, TUint, TUint)

IMPORT_C	TDialLocation	(	const TIntlPrefCode &	aIntlPrefCode,
			const TNatPrefCode &	aNatPrefCode,
			const TNatCode &	aNatCode,
			const TAreaCode &	aAreaCode,
			const TDialOutLocalCode &	aDialOutLocalCode,
			const TDialOutLongDistanceCode &	aDialOutLongDistanceCode,
			const TDisableCallWaitingCode &	aDisableCallWaitingCode,
			TUint	aFlags,
			TUint	aPauseAfterDialout
		)

Creates a TDialLocation containing the parameters.

9.1

Parameters

const TIntlPrefCode & aIntlPrefCode	International Prefix Code. E.g. for the UK this is 00
const TNatPrefCode & aNatPrefCode	National Prefix Code. E.g. for the UK this is 44
const TNatCode & aNatCode	National Code. E.g. within the UK this is 0
const TAreaCode & aAreaCode	Area Code. E.g. for London this is 20
const TDialOutLocalCode & aDialOutLocalCode	Local Dial Out Code. Sometimes, the dial out codes differ depending upon whether dialling a local call or a long distance call. Typically 8 or 9 is used.
const TDialOutLongDistanceCode & aDialOutLongDistanceCode	Long Distance Dial-Out Code.
const TDisableCallWaitingCode & aDisableCallWaitingCode	This is the code to disable Call Waiting
TUint aFlags	Flags to set various options. It should contain the following flags: KPhoneNumberMobile, KPhoneNumberUsePulseDial, KPhoneNumberPbxUsePulseDial, KPhoneNumberWaitForDialingTone, KPhoneNumberWaitForProceedTone, KReturnPhoneNumberWithPlusFormat
TUint aPauseAfterDialout	Specified the delay after dial out. In the dial string the delay is represented as a comma character. This parameter indicates the length of the comma character.

Member Functions Documentation

AreaCode()

IMPORT_C TPtrC

AreaCode

(

)

const

Returns the Area Code. E.g. for London this is 20 9.1

ClearDialLocationFlags(TUint)

void

ClearDialLocationFlags

(

TUint

)

[inline]

9.1

Parameters

TUint

DialOutLocalCode()

IMPORT_C TPtrC

DialOutLocalCode

(

)

const

Returns the Local Dial-Out Code. Sometimes, the dial out codes differ depending upon whether dialling a local call or a long distance call. Typically 8 or 9 is used. 9.1

DialOutLongDistanceCode()

IMPORT_C TPtrC

DialOutLongDistanceCode

(

)

const

Returns the Long Distance Dial-Out Code. 9.1

DisableCallWaitingCode()

IMPORT_C TPtrC

DisableCallWaitingCode

(

)

const

Returns the code to disable Call Waiting 9.1

IntlPrefCode()

IMPORT_C TPtrC

IntlPrefCode

(

)

const

Returns the International Prefix Code. E.g. for the UK this is 00 9.1

IsDialOutRequired()

IMPORT_C TBool

IsDialOutRequired

(

)

const

True if a code is needed to dial out either local or long distance calls. 9.1

IsDisableCallWaitingCode()

IMPORT_C TBool

IsDisableCallWaitingCode

(

)

const

True if call waiting is disabled. If no code was supplied to disable call waiting then false is returned. 9.1

IsMobile()

IMPORT_C TBool

IsMobile

(

)

const

True if the KPhoneNumberMobile flag is set 9.1

IsPbxUsePulseDial()

IMPORT_C TBool

IsPbxUsePulseDial

(

)

const

True if the KPhoneNumberPbxUsePulseDial flag is set 9.1

IsReturnPhoneNumberWithPlusFormat()

TBool

IsReturnPhoneNumberWithPlusFormat

(

)

const [inline]

True if the KReturnPhoneNumberWithPlusFormat flag is set

9.1

IsUsePulseDial()

IMPORT_C TBool

IsUsePulseDial

(

)

const

True if the KPhoneNumberUsePulseDial flag is set 9.1

IsWaitForDialingTone()

IMPORT_C TBool

IsWaitForDialingTone

(

)

const

True if the KPhoneNumberWaitForDialingTone flag is set 9.1

IsWaitForProceedTone()

IMPORT_C TBool

IsWaitForProceedTone

(

)

const

True if the KPhoneNumberWaitForProceedTone flag is set 9.1

NatCode()

IMPORT_C TPtrC

NatCode

(

)

const

Returns the National Code. E.g. within the UK this is 0 9.1

NatPrefCode()

IMPORT_C TPtrC

NatPrefCode

(

)

const

Returns the National Prefix Code. E.g. for the UK this is 44 9.1

PauseAfterDialout()

IMPORT_C TInt

PauseAfterDialout

(

)

const

Returns the delay after dial out. In the dial string the delay is represented as a comma character. This parameter indicates the length of the comma character. 9.1

SetAreaCode(const TDesC &)

IMPORT_C void

SetAreaCode

(

const TDesC &

)

Set the Area Code. E.g. for London this is 20 9.1

Parameters

const TDesC &

SetDialLocationFlags(TUint)

IMPORT_C void

SetDialLocationFlags

(

TUint

)

Set the location flags. Any of the following flags can be set:

KPhoneNumberMobile

KPhoneNumberUsePulseDial

KPhoneNumberPbxUsePulseDial

KPhoneNumberWaitForDialingTone

KPhoneNumberWaitForProceedTone

KReturnPhoneNumberWithPlusFormat

9.1

Parameters

TUint

SetDialOutLocalCode(const TDesC &)

IMPORT_C void

SetDialOutLocalCode

(

const TDesC &

)

Set the Local Dial Out Code. Sometimes, the dial out codes differ depending upon whether dialling a local call or a long distance call. Typically 8 or 9 is used. 9.1

Parameters

const TDesC &

SetDialOutLongDistanceCode(const TDesC &)

IMPORT_C void

SetDialOutLongDistanceCode

(

const TDesC &

)

Set the Long Distance Code. 9.1

Parameters

const TDesC &

SetDisableCallWaitingCode(const TDesC &)

IMPORT_C void

SetDisableCallWaitingCode

(

const TDesC &

)

Set the code to disable Call Waiting 9.1

Parameters

const TDesC &

SetIntlPrefCode(const TDesC &)

IMPORT_C void

SetIntlPrefCode

(

const TDesC &

)

Set the International Prefix Code. E.g. for the UK this is 00 9.1

Parameters

const TDesC &

SetNatCode(const TDesC &)

IMPORT_C void

SetNatCode

(

const TDesC &

)

Set the National Code. E.g. within the UK this is 0 9.1

Parameters

const TDesC &

SetNatPrefCode(const TDesC &)

IMPORT_C void

SetNatPrefCode

(

const TDesC &

)

Set the National Prefix Code. E.g. for the UK this is 44 9.1

Parameters

const TDesC &

SetPauseAfterDialout(TUint)

IMPORT_C void

SetPauseAfterDialout

(

TUint

)

Set the delay after dial out. In the dial string the delay is represented as a comma character. This parameter indicates the length of the comma character. 9.1