Instance Method インスタンスメソッド

description(withCalendarFormat:timeZone:locale:)

Returns a string representation of the date formatted as specified by given conversion specifiers. 与えられた変換指定子によって書式設定される日付の文字列表現を返します。

Declaration 宣言

func description(withCalendarFormat format: String?, 
        timeZone aTimeZone: TimeZone?, 
          locale: Any?) -> String?

Parameters パラメータ

formatString

The format for the returned string (see Date and Number Formatters in OS X v10.0 to 10.3 for a discussion of how to create the format string). Pass nil to use the default format string, “%Y-%m-%d %H:%M:%S %z” (this conforms to the international format YYYY-MM-DD HH:MM:SS ±HHMM.) 返される文字列に対する書式設定(OS X v10.0 から 10.3 までの Date and Number Formatters を書式設定文字列を作成する方法の議論として見てください)。nilを渡して省略時の書式設定文字列を使ってください、“%Y-%m-%d %H:%M:%S %z”(これは国際化書式設定YYYY-MM-DD HH:MM:SS ±HHMMに準拠します)。

aTimeZone

The time zone in which to represent the receiver. Pass nil to use the default time zone—specific to the current locale. それにおいてレシーバを表すことになるタイムゾーン。nilを渡して省略時のタイムゾーンを使ってください — 現在のロケールに特有。

localeDictionary

An NSDictionary object containing locale data. To use the user's preferences, you can use [[NSUserDefaults standardUserDefaults] dictionaryRepresentation]. ローカルデータを含んでいるNSDictionary。ユーザの環境設定を使うために、あなたは[[NSUserDefaults standardUserDefaults] dictionaryRepresentation]を使うことができます。

If you pass nil or an instance of NSLocale, NSDate uses the system default locale—this is not the same as the current user's locale. あなたがnilまたはNSLocaleのインスタンスを渡すならば、NSDateはシステム初期設定のロケールを使います — これは現在のユーザのロケールと同じではありません。

Return Value 戻り値

A string representation of the receiver, formatted as specified by the given conversion specifiers. 与えられた変換指定子によって指定されるように書式設定される、レシーバの文字列表現。

Discussion 議論

There are several problems with the implementation of this method that cannot be fixed for compatibility reasons. To format a date, you should use a date formatter object instead (see DateFormatter and Data Formatting Guide). 幾つかの問題がこのメソッドの実装であります、それは互換性の理由から改善することができません。日付を書式設定するために、あなたは日付フォーマッタオブジェクトを代わりに使うべきです(DateFormatterData Formatting Guideを見てください)。

You could use this method to print the current time as follows: あなたは、このメソッドを使って現在の時刻を次のように出力できます:


sprintf(aString, "The current time is %s\n", [[[NSDate  date]
    descriptionWithCalendarFormat:@"%H:%M:%S %Z" timeZone:nil
    locale:[[NSUserDefaults standardUserDefaults] dictionaryRepresentation]]
        UTF8String]);

See Also 参照

Legacy Operations レガシー演算

Related Documentation 関連文書