description(withLocale:indent:)
Returns a string that represents the contents of the array, formatted as a property list.
Declaration
func description(withLocale locale: Any?, indent level: Int) -> StringParameters
- locale:
An
NSLocaleobject or anNSDictionaryobject that specifies options used for formatting each of the array’s elements (where recognized). Specifynilif you don’t want the elements formatted. - level:
A level of indent, to make the output more readable: set
levelto0to use four spaces to indent, or1to indent the output with a tab character.
Return Value
A string that represents the contents of the array, formatted as a property list.
Discussion
The returned NSString object contains the string representations of each of the array’s elements, in order, from first to last. To obtain the string representation of a given element, description(withLocale:indent:) proceeds as follows:
If the element is an
NSStringobject, it is used as is.If the element responds to description(withLocale:indent:), that method is invoked to obtain the element’s string representation.
If the element responds to description(withLocale:), that method is invoked to obtain the element’s string representation.
If none of the above conditions is met, the element’s string representation is obtained by invoking its description method.