Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: dial.h
Link against: dial.lib

Class TDialLocation

class TDialLocation;

Description

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

There are functions to get and set this information.

Members

Defined in TDialLocation:
AreaCode(), DialOutLocalCode(), DialOutLongDistanceCode(), DisableCallWaitingCode(), IntlPrefCode(), IsDialOutRequired(), IsDisableCallWaitingCode(), IsMobile(), IsPbxUsePulseDial(), IsUsePulseDial(), IsWaitForDialingTone(), IsWaitForProceedTone(), NatCode(), NatPrefCode(), PauseAfterDialout(), SetAreaCode(), SetDialLocationFlags(), SetDialOutLocalCode(), SetDialOutLongDistanceCode(), SetDisableCallWaitingCode(), SetIntlPrefCode(), SetNatCode(), SetNatPrefCode(), SetPauseAfterDialout(), TDialLocation(), TDialLocation()


Construction and destruction


TDialLocation()

IMPORT_C TDialLocation();

Description

Creates an empty TDialLocation.


TDialLocation()

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);

Description

Creates a TDialLocation containing the parameters.

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.

[Top]


Member functions


SetIntlPrefCode()

IMPORT_C void SetIntlPrefCode(const TDesC &);

Description

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

Parameters

const TDesC &


SetNatPrefCode()

IMPORT_C void SetNatPrefCode(const TDesC &);

Description

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

Parameters

const TDesC &


SetNatCode()

IMPORT_C void SetNatCode(const TDesC &);

Description

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

Parameters

const TDesC &


SetAreaCode()

IMPORT_C void SetAreaCode(const TDesC &);

Description

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

Parameters

const TDesC &


SetDialOutLocalCode()

IMPORT_C void SetDialOutLocalCode(const TDesC &);

Description

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.

Parameters

const TDesC &


SetDialOutLongDistanceCode()

IMPORT_C void SetDialOutLongDistanceCode(const TDesC &);

Description

Set the Long Distance Code.

Parameters

const TDesC &


SetDisableCallWaitingCode()

IMPORT_C void SetDisableCallWaitingCode(const TDesC &);

Description

Set the code to disable Call Waiting

Parameters

const TDesC &


SetDialLocationFlags()

IMPORT_C void SetDialLocationFlags(TUint);

Description

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

KPhoneNumberMobile

KPhoneNumberUsePulseDial

KPhoneNumberPbxUsePulseDial

KPhoneNumberWaitForDialingTone

KPhoneNumberWaitForProceedTone

KReturnPhoneNumberWithPlusFormat

Parameters

TUint


SetPauseAfterDialout()

IMPORT_C void SetPauseAfterDialout(TUint);

Description

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.

Parameters

TUint


IntlPrefCode()

IMPORT_C TPtrC IntlPrefCode() const;

Description

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

Return value

TPtrC


NatPrefCode()

IMPORT_C TPtrC NatPrefCode() const;

Description

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

Return value

TPtrC


NatCode()

IMPORT_C TPtrC NatCode() const;

Description

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

Return value

TPtrC


AreaCode()

IMPORT_C TPtrC AreaCode() const;

Description

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

Return value

TPtrC


DialOutLocalCode()

IMPORT_C TPtrC DialOutLocalCode() const;

Description

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.

Return value

TPtrC


DialOutLongDistanceCode()

IMPORT_C TPtrC DialOutLongDistanceCode() const;

Description

Returns the Long Distance Dial-Out Code.

Return value

TPtrC


DisableCallWaitingCode()

IMPORT_C TPtrC DisableCallWaitingCode() const;

Description

Returns the code to disable Call Waiting

Return value

TPtrC


PauseAfterDialout()

IMPORT_C TInt PauseAfterDialout() const;

Description

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.

Return value

TInt


IsMobile()

IMPORT_C TBool IsMobile() const;

Description

True if the KPhoneNumberMobile flag is set

Return value

TBool


IsUsePulseDial()

IMPORT_C TBool IsUsePulseDial() const;

Description

True if the KPhoneNumberUsePulseDial flag is set

Return value

TBool


IsPbxUsePulseDial()

IMPORT_C TBool IsPbxUsePulseDial() const;

Description

True if the KPhoneNumberPbxUsePulseDial flag is set

Return value

TBool


IsWaitForDialingTone()

IMPORT_C TBool IsWaitForDialingTone() const;

Description

True if the KPhoneNumberWaitForDialingTone flag is set

Return value

TBool


IsWaitForProceedTone()

IMPORT_C TBool IsWaitForProceedTone() const;

Description

True if the KPhoneNumberWaitForProceedTone flag is set

Return value

TBool


IsDialOutRequired()

IMPORT_C TBool IsDialOutRequired() const;

Description

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

Return value

TBool


IsDisableCallWaitingCode()

IMPORT_C TBool IsDisableCallWaitingCode() const;

Description

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

Return value

TBool