Address Book UI Functions Reference

Framework
AddressBookUI/AddressBookUI.h
Declared in
ABAddressFormatting.h

Overview

The Address Book UI functions provide functionality for formatting contact information.

Functions

ABCreateStringWithAddressDictionary

Returns a formatted address from an address property.

NSString *ABCreateStringWithAddressDictionary (
   NSDictionary *address,
   BOOL addCountryName
);
Parameters
address

A dictionary representing the address property to format.

addCountryName

Specifies whether to include the name of the country in the returned formatted address.

When NO and address includes a country name, that country name is still included in the return value.

When YES and address doesn’t include a country name, the country name is added to the return value. (The country name is generated from the country code entry in address; see "Address Property" in ABPerson Reference.)

Return Value

The formatted address (may include line endings).

Discussion

The address is formatted based on the address's country code (kABPersonAddressCountryCodeKey). In general, the country code should be set to correspond with the country name (kABPersonAddressCountryKey).

Availability
  • Available in iOS 2.0 and later.
Related Sample Code
Declared In
ABAddressFormatting.h