Instance Method

description(withLocale:)

Returns a string object that represents the contents of the dictionary, formatted as a property list.

Declaration

func description(withLocale locale: Any?) -> String

Parameters

locale

An object that specifies options used for formatting each of the dictionary’s keys and values; pass nil if you don’t want them formatted.

On iOS and macOS 10.5 and later, either an instance of NSDictionary or an NSLocale object may be used for locale. In OS X v10.4 and earlier it must be an instance of NSDictionary.

Discussion

For a description of how locale is applied to each element in the dictionary, see description(withLocale:indent:).

If each key in the dictionary responds to compare:, the entries are listed in ascending order by key, otherwise the order in which the entries are listed is undefined.

See Also

Describing a Dictionary

var description: String

A string that represents the contents of the dictionary, formatted as a property list.

var descriptionInStringsFileFormat: String

A string that represents the contents of the dictionary, formatted in .strings file format.

func description(withLocale: Any?, indent: Int) -> String

Returns a string object that represents the contents of the dictionary, formatted as a property list.

var customMirror: Mirror

A mirror that reflects the dictionary.