SHFormatDateTimeA 函式 (shlwapi.h)

發行項
03/05/2024

[SHFormatDateTime 可用於需求一節中指定的操作系統。它可能會在後續版本中改變或無法使用。]

產生指定為 FILETIME 結構的時間字串表示。

語法

int SHFormatDateTimeA(
  [in]                const FILETIME *pft,
  [in, out, optional] DWORD          *pdwFlags,
  [out]               LPSTR          pszBuf,
                      UINT           cchBuf
);

參數

[in] pft

類型： const FILETIME UNALIGNED*

FILETIME 結構的指標，其時間要轉換成字串。

[in, out, optional] pdwFlags

類型： DWORD*

DWORD 值的指標，其中包含指定日期和時間格式的位旗標。

當您呼叫函式時，您可以結合下列零個或多個旗標，但例外狀況如下。您也可以將此參數設定為 NULL，在此情況下，函式會假設已設定FDTF_DEFAULT旗標。

FDTF_SHORTTIME (0x00000001)

0x00000001。將地區和語言選項應用程式所指定的一天時間格式化為控制台，但沒有秒數。此旗標無法與FDTF_LONGTIME結合。

短時間已成功格式化。

FDTF_SHORTDATE (0x00000002)

0x00000002。將控制台中地區和語言選項應用程式中的簡短日期格式所指定的日期格式化。此旗標無法與FDTF_LONGDATE結合。

簡短日期已成功格式化。

FDTF_DEFAULT

相當於 FDTF_SHORTDATE |FDTF_SHORTTIME。

FDTF_LONGDATE (0x00000004)

0x00000004。在控制台的地區和語言選項應用程式中，將日期格式化為長日期格式所指定的日期。此旗標無法與FDTF_SHORTDATE結合。

已成功格式化長日期。

FDTF_LONGTIME (0x00000008)

0x00000008。將地區和語言選項應用程式所指定的一天時間格式化為控制台，包括秒數。此旗標無法與FDTF_SHORTTIME結合。

已成功格式化很長的時間。

FDTF_RELATIVE (0x00000010)

0x00000010。如果已設定FDTF_LONGDATE旗標，且 FILETIME 結構中的日期與 SHFormatDateTime 呼叫的日期相同，則當目前) 變更為 “Today” 時，當星期的日期 (。如果結構中的日期是前一天，則當周的日期變更為「昨天」時，如果目前) 則為「昨天」，則星期幾 (。

相對表示法用於日期。

FDTF_LTRDATE (0x00000100)

0x00000100。新增由左至右閱讀版面配置的標記。此旗標無法與FDTF_RTLDATE結合。

FDTF_RTLDATE (0x00000200)

0x00000200。新增由右至左閱讀版面配置的標記。此旗標無法與FDTF_LTRDATE結合。

FDTF_NOAUTOREADINGORDER (0x00000400)

0x00000400。不會插入讀取順序標記。一般而言，在沒有FDTF_LTRDATE或FDTF_RTLDATE旗標的情況下， SHFormatDateTime 會決定使用者默認地區設定的讀取順序、插入讀取順序標記，並適當地更新 pdwFlags 輸出值。此旗標可防止該進程發生。它最常由 SHFormatDateTime的舊版呼叫端使用。此旗標無法與FDTF_RTLDATE或FDTF_LTRDATE結合。

Windows Server 2003 和 Windows XP： 這個值無法使用。

當函式傳回時，此參數所指向的 DWORD 值可以包含下列零個或多個旗標。

[out] pszBuf

類型： LPTSTR

接收格式化日期和時間之緩衝區的指標。緩衝區必須夠大，才能包含 cchBuf 參數所指定的 TCHAR 字元數目，包括終止的 Null 字元。

cchBuf

類型： UINT

pszBuf 指向的緩衝區可包含的 TCHAR 數目。

傳回值

類型： int

傳回寫入緩衝區的 TCHA 數目，包括終止的 Null 字元。失敗時，此值為 0。

備註

注意

shlwapi.h 標頭會將SHFormatDateTime定義為別名，根據UNICODE預處理器常數的定義，自動選取此函式的ANSI或Unicode版本。混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

規格需求

需求	值
最低支援的用戶端	Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限傳統型應用程式]
目標平台	Windows
標頭	shlwapi.h
程式庫	Shlwapi.lib
Dll	Shlwapi.dll (5.0 版或更新版本)

另請參閱

GetDateFormat

GetTimeFormat