Class TWorldId

Interface status:

deprecated

Interface is deprecated and is available for backward compatibility reasons only

class TWorldId;

Description

World ID.

This class stores the world ID for a city/country. This consists of the city and country names. Unique IDs of this type are used to identify every city in the world database.

It also defines a field for setting whether city searches span the whole database, or just the current country.

Members

Defined in TWorldId:

• City()Gets the city name in the current TWorldId
• Country()Gets the country name in the current TWorldId
• Select()Gets the current city search mode
• SetSelect()Sets the city search mode
• TWorldId()Constructs a city ID object, and initialises it with the search locale EWithinWorld

Interface status:

deprecated

Inherited from: TWorldId

IMPORT_C TWorldId();

Description

Constructs a city ID object, and initialises it with the search locale EWithinWorld.

Interface status:

deprecated

Inherited from: TWorldId

inline const TCityName &City() const;

Description

Gets the city name in the current TWorldId.

Return value

const TCityName & A reference to the city name.

Interface status:

deprecated

Inherited from: TWorldId

inline const TCountryName &Country() const;

Description

Gets the country name in the current TWorldId.

Return value

const TCountryName & A reference to the country name.

Interface status:

deprecated

Inherited from: TWorldId

inline TWldSelect Select() const;

Description

Gets the current city search mode. Clients can search for cities by country, or over the whole world database.

Return value

TWldSelect The current city search mode.

Interface status:

deprecated

Inherited from: TWorldId

inline void SetSelect(TWldSelect aSelector);

Description

Sets the city search mode. Clients can search for cities by country, or over the whole world database.

Parameters

TWldSelect aSelector The city search mode.