FormatDateTime 函式 (Visual Basic)

發行項
08/21/2008

更新：2007 年 11 月

傳回代表日期/時間值的字串運算式。

Function FormatDateTime(
   ByVal Expression As DateTime,
   Optional ByVal NamedFormat As DateFormat = DateFormat.GeneralDate
) As String

參數

Expression
必要項。要格式化的 Date 運算式。
NamedFormat
選擇項。指示所使用之日期/時間格式的數值。如果省略，則使用 DateFormat.GeneralDate。

設定

NamedFormat 引數具有下列設定：

常數	描述
DateFormat.GeneralDate	顯示日期和 (或) 時間。以簡短日期形式顯示日期部分。如果有時間部分，則會顯示為完整時間。如果兩者都有，則會同時顯示這兩個部分。
DateFormat.LongDate	使用電腦地區設定中指定之完整日期格式來顯示日期。
DateFormat.ShortDate	使用電腦地區設定中指定之簡短日期格式來顯示日期。
DateFormat.LongTime	使用電腦地區設定中指定之時間格式來顯示時間。
DateFormat.ShortTime	使用 24 小時制 (hh:mm) 來顯示時間。

例外狀況

例外狀況類型	錯誤代碼	條件
ArgumentException	5	NamedFormat 設定無效。

如果將使用非結構化錯誤處理的 Visual Basic 6.0 應用程式升級，請參閱「錯誤代碼」資料行 (您可以將錯誤代碼與 Number 屬性 (Err 物件) 比對)。但是，請盡可能考慮以 Visual Basic 的結構化例外處理概觀取代這類錯誤控制項。

備註

Date 資料型別一定會包含日期和時間資訊。為了方便進行型別轉換，Visual Basic 將 1/1/1 (1 年 1 月 1 日) 視為日期的中性值，將 00:00:00 (午夜) 視為時間的中性值。如果您將 Date 值格式化為日期/時間字串，FormatDateTime 不會在產生的字串中包含中性值。例如，如果您將 #1/1/0001 9:30:00# 轉換為字串，結果會是 "9:30:00 AM"；日期資訊會隱藏。不過，原始 Date 值中還是保留日期資訊，您可使用如 DatePart 的函式來復原它。

注意事項：
如果您將 Expression 引數當做 String 常值傳遞，FormatDateTime 會根據應用程式的 CurrentCulture 設定來轉譯它。不過，如果您將其當做 Date 常值傳遞，則必須使用 #mm/dd/yyyy# 格式，因為 FormatDateTime 一律會根據英文 (美國) 文化特性來解譯 Date 常值。格式選擇是必要的，因為如果利用某一文化特性的 Date 常值進行應用程式開發和編碼，但執行平台卻是不同的文化特性，則 Date 常值剖析可能不正確。

如果您將 Expression 引數當做 String 常值傳遞，FormatDateTime 會根據應用程式的 CurrentCulture 設定來轉譯它。不過，如果您將其當做 Date 常值傳遞，則必須使用 #mm/dd/yyyy# 格式，因為 FormatDateTime 一律會根據英文 (美國) 文化特性來解譯 Date 常值。格式選擇是必要的，因為如果利用某一文化特性的 Date 常值進行應用程式開發和編碼，但執行平台卻是不同的文化特性，則 Date 常值剖析可能不正確。

範例

這個範例將說明 FormatDateTime 函式的用法。

' English (US) format.
Dim TestDate As DateTime = #3/12/1999#

' FormatDateTime returns "Friday, March 12, 1999".
' The time information is neutral (00:00:00) and therefore suppressed.
Dim TestString As String = FormatDateTime(TestDate, DateFormat.LongDate)