
DEVELOPER LIBRARY

» Developer Library » API Reference » C++ API reference » Dial » TDialLocation

Location: dial.h
Link against: dial.lib

Class `TDialLocation`

class TDialLocation;

Support

Supported from 5.0

Description

Basic telephone configuration information.

This class stores configuration details related to the current location of the telephone equipment, how to access national and international telephone networks and basic information about the equipment such as 'Phone is mobile'.

Defined in TDialLocation:
AreaCode(), ClearDialLocationFlags(), DialOutLocalCode(), DialOutLongDistanceCode(), DisableCallWaitingCode(), IntlPrefCode(), IsDialOutRequired(), IsDisableCallWaitingCode(), IsMobile(), IsPbxUsePulseDial(), IsReturnPhoneNumberWithPlusFormat(), IsUsePulseDial(), IsWaitForDialingTone(), IsWaitForProceedTone(), NatCode(), NatPrefCode(), PauseAfterDialout(), SetAreaCode(), SetDialLocationFlags(), SetDialOutLocalCode(), SetDialOutLongDistanceCode(), SetDisableCallWaitingCode(), SetIntlPrefCode(), SetNatCode(), SetNatPrefCode(), SetPauseAfterDialout(), TDialLocation(), TDialLocation(), iAreaCode, iDialOutLocalCode, iDialOutLongDistanceCode, iDisableCallWaitingCode, iFlags, iIntlPrefCode, iNatCode, iNatPrefCode, iPauseAfterDialout

Construction and destruction

`TDialLocation()`

TDialLocation();

Description

Creates a default TDialLocation object.

`TDialLocation()`

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 object and initialises its data to the value provided in the associated parameters.

Parameters

`const TIntlPrefCode& aIntlPrefCode`	The international prefix code.
`const TNatPrefCode& aNatPrefCode`	The national code number.
`const TNatCode& aNatCode`	The code prefixed to all national numbers.
`const TAreaCode& aAreaCode`	The area code.
`const TDialOutLocalCode& aDialOutLocalCode`	The code to enable local calls from a private telephone network.
`const TDialOutLongDistanceCode& aDialOutLongDistanceCode`	The code to enable long distance calls from a private telephone network.
`const TDisableCallWaitingCode& aDisableCallWaitingCode`	The code to disable call waiting.
`TUint aFlags`	Set options such as 'Phone is mobile', 'Modem is using Tone/Pulse dialling' and so on.
`TUint aPauseAfterDialout`	The length of time between using a dial-out code and the rest of the telephone number.

Member functions

`SetIntlPrefCode()`

void SetIntlPrefCode(const TDesC&);

Description

Sets the international prefix code.

Parameters

const TDesC&

The international prefix code, in the UK this is '00'.

`SetNatPrefCode()`

void SetNatPrefCode(const TDesC&);

Description

Sets the national prefix number.

Parameters

const TDesC&

The national prefix number. for example, the Netherlands is '31'.

`SetNatCode()`

void SetNatCode(const TDesC&);

Description

Sets the code prefixed to all national numbers.

Parameters

const TDesC&

The code prefixed to all national numbers, for example, in the UK this is '0'.

`SetAreaCode()`

void SetAreaCode(const TDesC&);

Description

Sets the area code.

Parameters

const TDesC&

The area code, minus any leading zeros.

`SetDialOutLocalCode()`

void SetDialOutLocalCode(const TDesC&);

Description

Sets the code used to get local lines on a private telephone network.

Parameters

const TDesC&

The local code, typically in the UK this is either '8' or '9'.

`SetDialOutLongDistanceCode()`

void SetDialOutLongDistanceCode(const TDesC&);

Description

Sets the code used to get long distance lines on a private telephone network.

Parameters

const TDesC&

The long distance code, typically in the UK this is either '8' or '9'.

`SetDisableCallWaitingCode()`

void SetDisableCallWaitingCode(const TDesC&);

Description

Disables call waiting.

Parameters

const TDesC&

The code to disable Call Waiting.

`SetDialLocationFlags()`

void SetDialLocationFlags(TUint);

Description

Sets various dial location optional flags.

For more information see Dialling equipment attributes.

Parameters

TUint

The dial location flags to set.

`ClearDialLocationFlags()`

inline void ClearDialLocationFlags(TUint);

Description

Clears the specified dial location flags.

Parameters

TUint

The dial location flags to clear.

`SetPauseAfterDialout()`

void SetPauseAfterDialout(TUint);

Description

Specifies whether to follow a local or long distance dial-out code with a pause indicator.

Parameters

TUint

'0' for no pause, any other value, use pause character.

`IntlPrefCode()`

TPtrC IntlPrefCode() const;

Description

Returns the current international prefix code.

Return value


TPtrC

International prefix code.

`NatPrefCode()`

TPtrC NatPrefCode() const;

Description

Returns the current national prefix code.

Return value


TPtrC

National prefix code.

`NatCode()`

TPtrC NatCode() const;

Description

Returns the current national code.

Return value


TPtrC

National code.

`AreaCode()`

TPtrC AreaCode() const;

Description

Returns the current area code.

Return value


TPtrC

Area code.

`DialOutLocalCode()`

TPtrC DialOutLocalCode() const;

Description

Returns the current local dial out code.

Return value


TPtrC

Local dial out code.

`DialOutLongDistanceCode()`

TPtrC DialOutLongDistanceCode() const;

Description

Returns the current long distance dial out code.

Return value


TPtrC

Long distance dial out code.

`DisableCallWaitingCode()`

TPtrC DisableCallWaitingCode() const;

Description

Returns the current disable call waiting code.

Return value


TPtrC

Disable call waiting code.

`PauseAfterDialout()`

TInt PauseAfterDialout() const;

Description

Determines if the pause character is to be used after the local or long distance dialing out code.

Return value


TInt

Returns '0' if no pause character is being used, any other value, the pause character is used.

`IsMobile()`

TBool IsMobile() const;

Description

Tests if the KPhoneNumberMobile dial location flag is set.

Return value


TBool

Returns ETrue if set, otherwise EFalse.

`IsReturnPhoneNumberWithPlusFormat()`

inline TBool IsReturnPhoneNumberWithPlusFormat() const;

Description

Tests if the KReturnPhoneNumberWithPlusFormat dial location flag is set.

Return value


TBool

Returns ETrue if set, otherwise EFalse.

`IsUsePulseDial()`

TBool IsUsePulseDial() const;

Description

Tests if the KPhoneNumberUsePulseDial dial location flag is set.

Return value


TBool

Returns ETrue if set, otherwise EFalse.

`IsPbxUsePulseDial()`

TBool IsPbxUsePulseDial() const;

Description

Tests if the KPhoneNumberPbxUsePulseDial dial location flag is set.

Return value


TBool

Returns ETrue if set, otherwise EFalse.

`IsWaitForDialingTone()`

TBool IsWaitForDialingTone() const;

Description

Tests if the KPhoneNumberWaitForDialingTone dial location flag is set.

Return value


TBool

Returns ETrue if set, otherwise EFalse.

`IsWaitForProceedTone()`

TBool IsWaitForProceedTone() const;

Description

Tests if the KPhoneNumberWaitForProceedTone dial location flag is set.

Return value


TBool

Returns ETrue if set, otherwise EFalse.

`IsDialOutRequired()`

TBool IsDialOutRequired() const;

Description

Tests if a local or long distance dial out code has been set.

Return value


TBool

Returns ETrue if set, otherwise EFalse.

`IsDisableCallWaitingCode()`

TBool IsDisableCallWaitingCode() const;

Description

Tests if the disable call waiting code has been set.

Return value


TBool

Returns ETrue if set, otherwise EFalse.