TDialLocation Class Reference

#include <dial.h>

Link against: dial.lib

class TDialLocation

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)

Detailed Description

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

There are functions to get and set this information.

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

Constructor & Destructor Documentation

TDialLocation ( )

IMPORT_C

TDialLocation

(

)

Creates an empty TDialLocation. Deprecated9.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.

Deprecated9.1

Parameter	Description
aIntlPrefCode	International Prefix Code. E.g. for the UK this is 00
aNatPrefCode	National Prefix Code. E.g. for the UK this is 44
aNatCode	National Code. E.g. within the UK this is 0
aAreaCode	Area Code. E.g. for London this is 20
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.
aDialOutLongDistanceCode	Long Distance Dial-Out Code.
aDisableCallWaitingCode	This is the code to disable Call Waiting
aFlags	Flags to set various options. It should contain the following flags: KPhoneNumberMobile, KPhoneNumberUsePulseDial, KPhoneNumberPbxUsePulseDial, KPhoneNumberWaitForDialingTone, KPhoneNumberWaitForProceedTone, KReturnPhoneNumberWithPlusFormat
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 Function Documentation

AreaCode ( )

IMPORT_C TPtrC

AreaCode

(

)

const

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

ClearDialLocationFlags ( TUint )

void

ClearDialLocationFlags

(

TUint

)

[inline]

Deprecated9.1

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. Deprecated9.1

DialOutLongDistanceCode ( )

IMPORT_C TPtrC

DialOutLongDistanceCode

(

)

const

Returns the Long Distance Dial-Out Code. Deprecated9.1

DisableCallWaitingCode ( )

IMPORT_C TPtrC

DisableCallWaitingCode

(

)

const

Returns the code to disable Call Waiting Deprecated9.1

IntlPrefCode ( )

IMPORT_C TPtrC

IntlPrefCode

(

)

const

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

IsDialOutRequired ( )

IMPORT_C TBool

IsDialOutRequired

(

)

const

True if a code is needed to dial out either local or long distance calls. Deprecated9.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. Deprecated9.1

IsMobile ( )

IMPORT_C TBool

IsMobile

(

)

const

True if the KPhoneNumberMobile flag is set Deprecated9.1

IsPbxUsePulseDial ( )

IMPORT_C TBool

IsPbxUsePulseDial

(

)

const

True if the KPhoneNumberPbxUsePulseDial flag is set Deprecated9.1

IsReturnPhoneNumberWithPlusFormat ( )

TBool

IsReturnPhoneNumberWithPlusFormat

(

)

const [inline]

True if the KReturnPhoneNumberWithPlusFormat flag is set

Deprecated9.1

IsUsePulseDial ( )

IMPORT_C TBool

IsUsePulseDial

(

)

const

True if the KPhoneNumberUsePulseDial flag is set Deprecated9.1

IsWaitForDialingTone ( )

IMPORT_C TBool

IsWaitForDialingTone

(

)

const

True if the KPhoneNumberWaitForDialingTone flag is set Deprecated9.1

IsWaitForProceedTone ( )

IMPORT_C TBool

IsWaitForProceedTone

(

)

const

True if the KPhoneNumberWaitForProceedTone flag is set Deprecated9.1

NatCode ( )

IMPORT_C TPtrC

NatCode

(

)

const

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

NatPrefCode ( )

IMPORT_C TPtrC

NatPrefCode

(

)

const

Returns the National Prefix Code. E.g. for the UK this is 44 Deprecated9.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. Deprecated9.1

SetAreaCode ( const TDesC & )

IMPORT_C void

SetAreaCode

(

const TDesC &

)

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

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

Deprecated9.1

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. Deprecated9.1

SetDialOutLongDistanceCode ( const TDesC & )

IMPORT_C void

SetDialOutLongDistanceCode

(

const TDesC &

)

Set the Long Distance Code. Deprecated9.1

SetDisableCallWaitingCode ( const TDesC & )

IMPORT_C void

SetDisableCallWaitingCode

(

const TDesC &

)

Set the code to disable Call Waiting Deprecated9.1

SetIntlPrefCode ( const TDesC & )

IMPORT_C void

SetIntlPrefCode

(

const TDesC &

)

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

SetNatCode ( const TDesC & )

IMPORT_C void

SetNatCode

(

const TDesC &

)

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

SetNatPrefCode ( const TDesC & )

IMPORT_C void

SetNatPrefCode

(

const TDesC &

)

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

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. Deprecated9.1