文書 > Foundation > Dates and Times > DateFormatter > dateFormat(fromTemplate:options:locale:)

型メソッド

dateFormat(fromTemplate:options:locale:)

指定されたロケールに対して適切に配置された、与えられた日付書式のコンポーネントを表す、ローカライズされた日付書式の文字列を返します。

宣言

class func dateFormat(fromTemplate tmplate: String, 
              options opts: Int, 
               locale: Locale?) -> String?

パラメータ

template	日付書式パターン ("MM" や "h" など) を含む文字列。詳細は、"日付と時間のプログラミングガイド" を参照してください。
opts	オプションは現在定義されていません。
locale	そのためにテンプレートが必要なロケール。

戻り値

locale で指定されたロケールに適切に配置された、template で与えられた日付書式コンポーネントを表す、ローカライズされた日付書式文字列。

返される文字列には、template で与えられたコンポーネントは正確には含まれていない場合があります。しかし、たとえば、ロケール固有の調整が適用されている可能性があります。

議論

異なるロケールは、日付コンポーネントの順序付けに異なる規則を使用します。このメソッドを使用して、指定されたロケールのコンポーネントの与えられたセットに対して適切な書式文字列を取得します (通常は現在のロケールを使用します-current を参照型の事)。

以下の例は、英語とアメリカ英語の間の日付形式の違いを示しています。


let usLocale = Locale(identifier: "en_US")
let gbLocale = Locale(identifier: "en_GB")
let template = "yMMMMd"
 
let usDateFormat = DateFormatter.dateFormat(fromTemplate: template, options: 0, locale: usLocale)!
// Date format for English (United States): "MMMM d, y"
let gbDateFormat = DateFormatter.dateFormat(fromTemplate: template, options: 0, locale: gbLocale)!
// Date format for English (United Kingdom): "d MMMM y"