Returns a localized date format string representing the given date format components arranged appropriately for the specified locale.
- iOS 4.0+
- macOS 10.6+
- Mac Catalyst 13.0+Beta
- tvOS 9.0+
- watchOS 2.0+
A string containing date format patterns (such as “MM” or “h”).
For full details, see Date and Time Programming Guide.
No options are currently defined.
The locale for which the template is required.
A localized date format string representing the date format components given in
template, arranged appropriately for the locale specified by
The returned string may not contain exactly those components given in
template, but may—for example—have locale-specific adjustments applied.
Different locales have different conventions for the ordering of date components. You use this method to get an appropriate format string for a given set of components for a specified locale (typically you use the current locale—see
The following example shows the difference between the date formats for British and American English: