Class TWorldId

TWorldId

Support

Supported from 5.0

Description

World ID.

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

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

Defined in TWorldId:
City(), Country(), Select(), SetSelect(), TWorldId()

TWorldId();

Description

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

const TCityName& City() const;

Description

Gets the city name in the current TWorldId.

Return value

TCityName& A reference to the city name.

const TCountryName& Country() const;

Description

Gets the country name in the current TWorldId.

Return value

TCountryName& A reference to the country name.

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.

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.