using System; using System.Runtime.InteropServices; using System.Text; namespace Vanara.PInvoke { public static partial class Kernel32 { ///

Flags specifying time format options.

[Flags] public enum TIME_FORMAT : uint { ///

Do not use minutes or seconds.

TIME_NOMINUTESORSECONDS = 1, ///

Do not use seconds.

TIME_NOSECONDS = 2, ///

Do not use a time marker.

TIME_NOTIMEMARKER = 4, ///

Always use a 24-hour time format.

TIME_FORCE24HOURFORMAT = 8, ///

/// Windows Me/98, Windows 2000: System default Windows ANSI code page (ACP) instead of the locale code page used for string /// translation. See Code Page Identifiers for a list of ANSI and other code pages. ///

LOCAL_USE_CP_ACP = 0x40000000, ///

/// No user override. In several functions, for example, GetLocaleInfo and GetLocaleInfoEx, this constant causes the function to /// bypass any user override and use the system default value for any other constant specified in the function call. The /// information is retrieved from the locale database, even if the identifier indicates the current locale and the user has /// changed some of the values using the Control Panel, or if an application has changed these values by using SetLocaleInfo. If /// this constant is not specified, any values that the user has configured from the Control Panel or that an application has /// configured using SetLocaleInfo take precedence over the database settings for the current system default locale. ///

LOCALE_NOUSEROVERRIDE = 0x80000000 } ///

/// Formats a date as a date string for a locale specified by the locale identifier. The function formats either a specified date or /// the local system date. ///

/// /// /// Locale identifier that specifies the locale this function formats the date string for. You can use the MAKELCID macro to create a /// locale identifier or use one of the following predefined values. /// /// /// /// LOCALE_CUSTOM_DEFAULT /// /// /// LOCALE_CUSTOM_UI_DEFAULT /// /// /// LOCALE_CUSTOM_UNSPECIFIED /// /// /// LOCALE_INVARIANT /// /// /// LOCALE_SYSTEM_DEFAULT /// /// /// LOCALE_USER_DEFAULT /// /// /// /// Flags specifying date format options. For detailed definitions, see the dwFlags parameter of GetDateFormatEx. /// /// Pointer to a SYSTEMTIME structure that contains the date information to format. The application sets this parameter to /// NULL if the function is to use the current local system date. /// /// /// /// Pointer to a format picture string that is used to form the date. Possible values for the format picture string are defined in /// Day, Month, Year, and Era Format Pictures. /// /// /// The function uses the specified locale only for information not specified in the format picture string, for example, the day and /// month names for the locale. The application can set this parameter to NULL to format the string according to the date /// format for the specified locale. /// /// /// Pointer to a buffer in which this function retrieves the formatted date string. /// /// Size, in characters, of the lpDateStr buffer. The application can set this parameter to 0 to return the buffer size required to /// hold the formatted date string. In this case, the buffer indicated by lpDateStr is not used. /// /// /// /// Returns the number of characters written to the lpDateStr buffer if successful. If the cchDate parameter is set to 0, the /// function returns the number of characters required to hold the formatted date string, including the terminating null character. /// /// /// The function returns 0 if it does not succeed. To get extended error information, the application can call GetLastError, which /// can return one of the following error codes: /// /// /// /// ERROR_INSUFFICIENT_BUFFER. A supplied buffer size was not large enough, or it was incorrectly set to NULL. /// /// /// ERROR_INVALID_FLAGS. The values supplied for flags were not valid. /// /// /// ERROR_INVALID_PARAMETER. Any of the parameter values was invalid. /// /// /// /// /// /// Note This API is being updated to support the May 2019 Japanese era change. If your application supports the Japanese /// calendar, you should validate that it properly handles the new era. See Prepare your application for the Japanese era change for /// more information. /// /// See Remarks for GetDateFormatEx. /// /// When the ANSI version of this function is used with a Unicode-only locale identifier, the function can succeed because the /// operating system uses the system code page. However, characters that are undefined in the system code page appear in the string /// as a question mark ("?"). /// /// /// Starting with Windows 8:GetDateFormat is declared in Datetimeapi.h. Before Windows 8, it was declared in Winnls.h. /// /// // https://docs.microsoft.com/en-us/windows/desktop/api/datetimeapi/nf-datetimeapi-getdateformata int GetDateFormatA( LCID Locale, // DWORD dwFlags, const SYSTEMTIME *lpDate, LPCSTR lpFormat, LPSTR lpDateStr, int cchDate ); [DllImport(Lib.Kernel32, SetLastError = true, CharSet = CharSet.Auto)] [PInvokeData("datetimeapi.h", MSDNShortId = "546cede1-1702-403a-bba3-b5cd3b35a1bf")] public static extern int GetDateFormat(LCID Locale, DATE_FORMAT dwFlags, in SYSTEMTIME lpDate, [Optional] string lpFormat, StringBuilder lpDateStr, int cchDate); ///

/// /// Formats a date as a date string for a locale specified by name. The function formats either a specified date or the local system date. /// /// /// Note This function can format data that changes between releases, for example, due to a custom locale. If your application /// must persist or transmit data, see Using Persistent Locale Data. /// ///

/// /// Pointer to a locale name, or one of the following predefined values. /// /// /// LOCALE_NAME_INVARIANT /// /// /// LOCALE_NAME_SYSTEM_DEFAULT /// /// /// LOCALE_NAME_USER_DEFAULT /// /// /// /// /// /// Flags specifying various function options that can be set if lpFormat is set to NULL. The application can specify a /// combination of the following values and LOCALE_USE_CP_ACP or LOCALE_NOUSEROVERRIDE. /// /// Caution Use of LOCALE_NOUSEROVERRIDE is strongly discouraged as it disables user preferences. /// /// /// Value /// Meaning /// /// /// DATE_AUTOLAYOUT /// /// Windows 7 and later: Detect the need for right-to-left and left-to-right reading layout using the locale and calendar /// information, and add marks accordingly. This value cannot be used with DATE_LTRREADING or DATE_RTLREADING. DATE_AUTOLAYOUT is /// preferred over DATE_LTRREADING and DATE_RTLREADING because it uses the locales and calendars to determine the correct addition of marks. /// /// /// /// DATE_LONGDATE /// Use the long date format. This value cannot be used with DATE_MONTHDAY, DATE_SHORTDATE, or DATE_YEARMONTH. /// /// /// DATE_LTRREADING /// Add marks for left-to-right reading layout. This value cannot be used with DATE_RTLREADING. /// /// /// DATE_RTLREADING /// Add marks for right-to-left reading layout. This value cannot be used with DATE_LTRREADING /// /// /// DATE_SHORTDATE /// Use the short date format. This is the default. This value cannot be used with DATE_MONTHDAY, DATE_LONGDATE, or DATE_YEARMONTH. /// /// /// DATE_USE_ALT_CALENDAR /// /// Use the alternate calendar, if one exists, to format the date string. If this flag is set, the function uses the default format /// for that alternate calendar, rather than using any user overrides. The user overrides will be used only in the event that there /// is no default format for the specified alternate calendar. /// /// /// /// DATE_YEARMONTH /// Windows Vista: Use the year/month format. This value cannot be used with DATE_MONTHDAY, DATE_SHORTDATE, or DATE_LONGDATE. /// /// /// DATE_MONTHDAY /// /// Windows 10: Use the combination of month and day formats appropriate for the specified locale. This value cannot be used with /// DATE_YEARMONTH, DATE_SHORTDATE, or DATE_LONGDATE. /// /// /// /// /// If the application does not specify DATE_YEARMONTH, DATE_MONTHDAY, DATE_SHORTDATE, or DATE_LONGDATE, and lpFormat is set to /// NULL, DATE_SHORTDATE is the default. /// /// /// /// Pointer to a SYSTEMTIME structure that contains the date information to format. The application can set this parameter to /// NULL if the function is to use the current local system date. /// /// /// /// Pointer to a format picture string that is used to form the date. Possible values for the format picture string are defined in /// Day, Month, Year, and Era Format Pictures. /// /// For example, to get the date string "Wed, Aug 31 94", the application uses the picture string "ddd',' MMM dd yy". /// /// The function uses the specified locale only for information not specified in the format picture string, for example, the day and /// month names for the locale. The application can set this parameter to NULL to format the string according to the date /// format for the specified locale. /// /// /// Pointer to a buffer in which this function retrieves the formatted date string. /// /// Size, in characters, of the lpDateStr buffer. The application can set this parameter to 0 to return the buffer size required to /// hold the formatted date string. In this case, the buffer indicated by lpDateStr is not used. /// /// Reserved; must set to NULL. /// /// /// Returns the number of characters written to the lpDateStr buffer if successful. If the cchDate parameter is set to 0, the /// function returns the number of characters required to hold the formatted date string, including the terminating null character. /// /// /// This function returns 0 if it does not succeed. To get extended error information, the application can call GetLastError, which /// can return one of the following error codes: /// /// /// /// ERROR_INSUFFICIENT_BUFFER. A supplied buffer size was not large enough, or it was incorrectly set to NULL. /// /// /// ERROR_INVALID_FLAGS. The values supplied for flags were not valid. /// /// /// ERROR_INVALID_PARAMETER. Any of the parameter values was invalid. /// /// /// /// /// /// Note This API is being updated to support the May 2019 Japanese era change. If your application supports the Japanese /// calendar, you should validate that it properly handles the new era. See Prepare your application for the Japanese era change for /// more information. /// /// The earliest date supported by this function is January 1, 1601. /// The day name, abbreviated day name, month name, and abbreviated month name are all localized based on the locale identifier. /// /// The date values in the structure indicated by lpDate must be valid. The function checks each of the date values: year, month, /// day, and day of week. If the day of the week is incorrect, the function uses the correct value, and returns no error. If any of /// the other date values are outside the correct range, the function fails, and sets the last error to ERROR_INVALID_PARAMETER. /// /// /// The function ignores the time members of the SYSTEMTIME structure indicated by lpDate. These include wHour, /// wMinute, wSecond, and wMilliseconds. /// /// /// If the lpFormat parameter contains a bad format string, the function returns no errors, but just forms the best possible date /// string. For example, the only year pictures that are valid are L"yyyy" and L"yy", where the "L" indicates a Unicode (16-bit /// characters) string. If L"y" is passed in, the function assumes L"yy". If L"yyy" is passed in, the function assumes L"yyyy". If /// more than four date (L"dddd") or four month (L"MMMM") pictures are passed in, the function defaults to L"dddd" or L"MMMM". /// /// /// The application should enclose any text that should remain in its exact form in the date string within single quotation marks in /// the date format picture. The single quotation mark can also be used as an escape character to allow the single quotation mark /// itself to be displayed in the date string. However, the escape sequence must be enclosed within two single quotation marks. For /// example, to display the date as "May '93", the format string is: L"MMMM ''''yy". The first and last single quotation marks are /// the enclosing quotation marks. The second and third single quotation marks are the escape sequence to allow the single quotation /// mark to be displayed before the century. /// /// /// When the date picture contains both a numeric form of the day (either d or dd) and the full month name (MMMM), the genitive form /// of the month name is retrieved in the date string. /// /// /// To obtain the default short and long date format without performing any actual formatting, the application should use /// GetLocaleInfoEx with the LOCALE_SSHORTDATE or LOCALE_SLONGDATE constant. To get the date format for an alternate calendar, the /// application uses GetLocaleInfoEx with the LOCALE_IOPTIONALCALENDAR constant. To get the date format for a particular calendar, /// the application uses GetCalendarInfoEx, passing the appropriate Calendar Identifier. It can call EnumCalendarInfoEx or /// EnumDateFormatsEx to retrieve date formats for a particular calendar. /// /// /// This function can retrieve data from custom locales. Data is not guaranteed to be the same from computer to computer or between /// runs of an application. If your application must persist or transmit data, see Using Persistent Locale Data. /// /// /// The DATE_LONGDATE format includes two kinds of date patterns: patterns that include the day of the week and patterns that do not /// include the day of the week. For example, "Tuesday, October 18, 2016" or "October 18, 2016". If your application needs to ensure /// that dates use one of these kinds of patterns and not the other kind, your application should perform the following actions: /// /// /// /// Call the EnumDateFormatsExEx function to get all of the date formats for the DATE_LONGDATE format. /// /// /// /// Look for the first date format passed to the callback function that you specified for EnumDateFormatsExEx that matches your /// requested calendar identifier and has a date format string that matches the requirements of your application. For example, look /// for the first date format that includes "dddd" if your application requires that the date include the full name of the day of the /// week, or look for the first date format that includes neither "ddd" nor "dddd" if your application requires that the date /// includes nether the abbreviated name nor the full name of the day of the week. /// /// /// /// /// Call the GetDateFormatEx function with the lpFormat parameter set to the date format string that you identified as the /// appropriate format in the callback function. /// /// /// /// /// If the presence or absence of the day of the week in the long date format does not matter to your application, your application /// can call GetDateFormatEx directly without first enumerating all of the long date formats by calling EnumDateFormatsExEx. /// /// /// Beginning in Windows 8: If your app passes language tags to this function from the Windows.Globalization namespace, it /// must first convert the tags by calling ResolveLocaleName. /// /// /// Beginning in Windows 8:GetDateFormatEx is declared in Datetimeapi.h. Before Windows 8, it was declared in Winnls.h. /// /// // https://docs.microsoft.com/en-us/windows/desktop/api/datetimeapi/nf-datetimeapi-getdateformatex int GetDateFormatEx( LPCWSTR // lpLocaleName, DWORD dwFlags, const SYSTEMTIME *lpDate, LPCWSTR lpFormat, LPWSTR lpDateStr, int cchDate, LPCWSTR lpCalendar ); [DllImport(Lib.Kernel32, SetLastError = true, ExactSpelling = true, CharSet = CharSet.Unicode)] [PInvokeData("datetimeapi.h", MSDNShortId = "791fb386-3cc5-410e-bfce-52598fdb10c9")] public static extern int GetDateFormatEx(string lpLocaleName, DATE_FORMAT dwFlags, in SYSTEMTIME lpDate, string lpFormat, StringBuilder lpDateStr, int cchDate, [Optional] string lpCalendar); ///

/// /// Formats time as a time string for a locale specified by identifier. The function formats either a specified time or the local /// system time. /// /// /// Note For interoperability reasons, the application should prefer the GetTimeFormatEx function to GetTimeFormat /// because Microsoft is migrating toward the use of locale names instead of locale identifiers for new locales. Any application that /// will be run only on Windows Vista and later should use GetTimeFormatEx. /// ///

/// /// /// Locale identifier that specifies the locale. You can use the MAKELCID macro to create a locale identifier or use one of the /// following predefined values. /// /// /// /// LOCALE_CUSTOM_DEFAULT /// /// /// LOCALE_CUSTOM_UI_DEFAULT /// /// /// LOCALE_CUSTOM_UNSPECIFIED /// /// /// LOCALE_INVARIANT /// /// /// LOCALE_SYSTEM_DEFAULT /// /// /// LOCALE_USER_DEFAULT /// /// /// /// Flags specifying time format options. For detailed definitions see the dwFlags parameter of GetTimeFormatEx. /// /// Pointer to a SYSTEMTIME structure that contains the time information to format. The application can set this parameter to /// NULL if the function is to use the current local system time. /// /// /// Pointer to a format picture to use to format the time string. If the application sets this parameter to NULL, the function /// formats the string according to the time format of the specified locale. If the application does not set the parameter to /// NULL, the function uses the locale only for information not specified in the format picture string, for example, the /// locale-specific time markers. For information about the format picture string, see the Remarks section. /// /// Pointer to a buffer in which this function retrieves the formatted time string. /// /// Size, in TCHAR values, for the time string buffer indicated by lpTimeStr. Alternatively, the application can set this parameter /// to 0. In this case, the function returns the required size for the time string buffer, and does not use the lpTimeStr parameter. /// /// /// /// Returns the number of TCHAR values retrieved in the buffer indicated by lpTimeStr. If the cchTime parameter is set to 0, the /// function returns the size of the buffer required to hold the formatted time string, including a terminating null character. /// /// /// This function returns 0 if it does not succeed. To get extended error information, the application can call GetLastError, which /// can return one of the following error codes: /// /// /// /// ERROR_INSUFFICIENT_BUFFER. A supplied buffer size was not large enough, or it was incorrectly set to NULL. /// /// /// ERROR_INVALID_FLAGS. The values supplied for flags were not valid. /// /// /// ERROR_INVALID_PARAMETER. Any of the parameter values was invalid. /// /// /// ERROR_OUTOFMEMORY. Not enough storage was available to complete this operation. /// /// /// /// /// See Remarks for GetTimeFormatEx. /// /// When the ANSI version of this function is used with a Unicode-only locale identifier, the function can succeed because the /// operating system uses the system code page. However, characters that are undefined in the system code page appear in the string /// as a question mark (?). /// /// /// Starting with Windows 8:GetTimeFormat is declared in Datetimeapi.h. Before Windows 8, it was declared in Winnls.h. /// /// // https://docs.microsoft.com/en-us/windows/desktop/api/datetimeapi/nf-datetimeapi-gettimeformata int GetTimeFormatA( LCID Locale, // DWORD dwFlags, const SYSTEMTIME *lpTime, LPCSTR lpFormat, LPSTR lpTimeStr, int cchTime ); [DllImport(Lib.Kernel32, SetLastError = true, CharSet = CharSet.Auto)] [PInvokeData("datetimeapi.h", MSDNShortId = "3db91d29-df97-4660-b3cd-0db5b42cfd01")] public static extern int GetTimeFormat(LCID Locale, TIME_FORMAT dwFlags, in SYSTEMTIME lpTime, [Optional] string lpFormat, StringBuilder lpTimeStr, int cchTime); ///

/// /// Formats time as a time string for a locale specified by name. The function formats either a specified time or the local system time. /// /// /// Note This function can format data that changes between releases, for example, due to a custom locale. If your application /// must persist or transmit data, see Using Persistent Locale Data. /// ///

/// /// Pointer to a locale name, or one of the following predefined values. /// /// /// LOCALE_NAME_INVARIANT /// /// /// LOCALE_NAME_SYSTEM_DEFAULT /// /// /// LOCALE_NAME_USER_DEFAULT /// /// /// /// /// /// Flags specifying time format options. The application can specify a combination of the following values and LOCALE_USE_CP_ACP or LOCALE_NOUSEROVERRIDE. /// /// Caution Use of LOCALE_NOUSEROVERRIDE is strongly discouraged as it disables user preferences. /// /// /// Value /// Meaning /// /// /// TIME_NOMINUTESORSECONDS /// Do not use minutes or seconds. /// /// /// TIME_NOSECONDS /// Do not use seconds. /// /// /// TIME_NOTIMEMARKER /// Do not use a time marker. /// /// /// TIME_FORCE24HOURFORMAT /// Always use a 24-hour time format. /// /// /// /// /// Pointer to a SYSTEMTIME structure that contains the time information to format. The application can set this parameter to /// NULL if the function is to use the current local system time. /// /// /// Pointer to a format picture to use to format the time string. If the application sets this parameter to NULL, the function /// formats the string according to the time format of the specified locale. If the application does not set the parameter to /// NULL, the function uses the locale only for information not specified in the format picture string, for example, the /// locale-specific time markers. For information about the format picture string, see the Remarks section. /// /// Pointer to a buffer in which this function retrieves the formatted time string. /// /// Size, in characters, for the time string buffer indicated by lpTimeStr. Alternatively, the application can set this parameter to /// 0. In this case, the function returns the required size for the time string buffer, and does not use the lpTimeStr parameter. /// /// /// /// Returns the number of characters retrieved in the buffer indicated by lpTimeStr. If the cchTime parameter is set to 0, the /// function returns the size of the buffer required to hold the formatted time string, including a terminating null character. /// /// /// This function returns 0 if it does not succeed. To get extended error information, the application can call GetLastError, which /// can return one of the following error codes: /// /// /// /// ERROR_INSUFFICIENT_BUFFER. A supplied buffer size was not large enough, or it was incorrectly set to NULL. /// /// /// ERROR_INVALID_FLAGS. The values supplied for flags were not valid. /// /// /// ERROR_INVALID_PARAMETER. Any of the parameter values was invalid. /// /// /// ERROR_OUTOFMEMORY. Not enough storage was available to complete this operation. /// /// /// /// /// /// If a time marker exists and the TIME_NOTIMEMARKER flag is not set, the function localizes the time marker based on the specified /// locale identifier. Examples of time markers are "AM" and "PM" for English (United States). /// /// /// The time values in the structure indicated by lpTime must be valid. The function checks each of the time values to determine that /// it is within the appropriate range of values. If any of the time values are outside the correct range, the function fails, and /// sets the last error to ERROR_INVALID_PARAMETER. /// /// /// The function ignores the date members of the SYSTEMTIME structure. These include: wYear, wMonth, wDayOfWeek, /// and wDay. /// /// /// If TIME_NOMINUTESORSECONDS or TIME_NOSECONDS is specified, the function removes the separators preceding the minutes and/or /// seconds members. /// /// If TIME_NOTIMEMARKER is specified, the function removes the separators preceding and following the time marker. /// /// If TIME_FORCE24HOURFORMAT is specified, the function displays any existing time marker, unless the TIME_NOTIMEMARKER flag is also set. /// /// The function does not include milliseconds as part of the formatted time string. /// /// The function returns no errors for a bad format string, but just forms the best possible time string. If more than two hour, /// minute, second, or time marker format pictures are passed in, the function defaults to two. For example, the only time marker /// pictures that are valid are "t" and "tt". If "ttt" is passed in, the function assumes "tt". /// /// /// To obtain the time format without performing any actual formatting, the application should use the GetLocaleInfoEx function, /// specifying LOCALE_STIMEFORMAT. /// /// /// The application can use the following elements to construct a format picture string. If spaces are used to separate the elements /// in the format string, these spaces appear in the same location in the output string. The letters must be in uppercase or /// lowercase as shown, for example, "ss", not "SS". Characters in the format string that are enclosed in single quotation marks /// appear in the same location and unchanged in the output string. /// /// /// /// Picture /// Meaning /// /// /// h /// Hours with no leading zero for single-digit hours; 12-hour clock /// /// /// hh /// Hours with leading zero for single-digit hours; 12-hour clock /// /// /// H /// Hours with no leading zero for single-digit hours; 24-hour clock /// /// /// HH /// Hours with leading zero for single-digit hours; 24-hour clock /// /// /// m /// Minutes with no leading zero for single-digit minutes /// /// /// mm /// Minutes with leading zero for single-digit minutes /// /// /// s /// Seconds with no leading zero for single-digit seconds /// /// /// ss /// Seconds with leading zero for single-digit seconds /// /// /// t /// One character time marker string, such as A or P /// /// /// tt /// Multi-character time marker string, such as AM or PM /// /// /// For example, to get the time string /// the application should use the picture string /// /// This function can retrieve data from custom locales. Data is not guaranteed to be the same from computer to computer or between /// runs of an application. If your application must persist or transmit data, see Using Persistent Locale Data. /// /// /// Beginning in Windows 8: If your app passes language tags to this function from the Windows.Globalization namespace, it /// must first convert the tags by calling ResolveLocaleName. /// /// /// Beginning in Windows 8:GetTimeFormatEx is declared in Datetimeapi.h. Before Windows 8, it was declared in Winnls.h. /// /// // https://docs.microsoft.com/en-us/windows/desktop/api/datetimeapi/nf-datetimeapi-gettimeformatex int GetTimeFormatEx( LPCWSTR // lpLocaleName, DWORD dwFlags, const SYSTEMTIME *lpTime, LPCWSTR lpFormat, LPWSTR lpTimeStr, int cchTime ); [DllImport(Lib.Kernel32, SetLastError = true, ExactSpelling = true, CharSet = CharSet.Unicode)] [PInvokeData("datetimeapi.h", MSDNShortId = "4d63888e-4496-4315-ac87-bf60c54daa37")] public static extern int GetTimeFormatEx(string lpLocaleName, TIME_FORMAT dwFlags, in SYSTEMTIME lpTime, [Optional] string lpFormat, StringBuilder lpTimeStr, int cchTime); } }