GetTimeFormat

原文链接 -> 传送门

函数功能：

GetTimeFormat 函数用于把时间字符串格式化为指定的区域时间格式。函数格式化一个指定的时间或本地的系统时间。

注意：由于互操作性，程序更倾向于使用 GetTimeFormatEx 函数而非 GetTimeFormat 函数，因为微软正在迁移到使用区域名称，取代使用区域标识。只运行在 Windows Vista 以及之后的 Windows 版本的应用程序应该使用 GetTimeFormatEx 函数。


API 函数原型：

注释：_In_ 说明该参数是输入的，_Out_ 说明该参数是输出的，_opt_ 说明该参数是可选的。

int GetTimeFormat(
  _In_            LCID       Locale,
  _In_            DWORD      dwFlags,
  _In_opt_  const SYSTEMTIME *lpTime,
  _In_opt_        LPCTSTR    lpFormat,
  _Out_opt_       LPTSTR     lpTimeStr,
  _In_            int        cchTime
);

参数解析：

返回值：

1. 如果函数调用成功，则返回写入 lpTimeStr 参数指向的缓冲区 TCHAR 字符数。如果 cchTime 参数设置为 0，则返回所需容纳格式化过的时间字符串的缓冲区大小，含结尾空字符；

2. 如果函数调用失败，则返回值是 0。

若想获得更多的错误信息，请调用 GetLastError 函数，下面是 GetLastError 函数返回的错误代码：

• ERROR_INSUFFICIENT_BUFFER：申请的缓冲区太小，或被错误地设置为 NULL
• ERROR_INVALID_FLAGS：分配給 dwFlags 参数的值无效
• ERROR_INVALID_PARAMETER：参数值全部都无效
• ERROR_OUTOFMEMORY：没有足够的可用内存来完成此操作

备注：

1. 更多详细信息，参见 GetTimeFormatEx 函数备注部分。

2. 当 GetTimeFormat 函数的 ANSI 版本在只有 Unicode 区域标识中使用，函数调用会成功因为操作系统使用系统代码页。但是，如果字符串中有系统代码页未定义的字符就以问号（?）表示。

3. 从 Windows 8 以及之后的 Windows 版本 GetTimeFormat 函数在 Datetimeapi.h 声明。在 Windows 8 之前，在 Winnls.h 声明。


需求：