ALib C++ Library
Library Version: 2510 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
fmtdatetime.inl
Go to the documentation of this file.
1//==================================================================================================
2/// \file
3/// This header-file is part of the module \alib_format of the \aliblong.
4///
5/// \emoji :copyright: 2013-2025 A-Worx GmbH, Germany.
6/// Published under \ref mainpage_license "Boost Software License".
7//==================================================================================================
9
10//==================================================================================================
11/// Implementation of \alib{format;FFormat} for boxable type \alib{time;DateTime}.<br>
12/// Writes the content of \p{box} (which is of type \b %DateTime) to the given \b %AString
13/// object \p{target} using a local instance of class \alib{strings::util;CalendarDateTime}
14/// and its method \alib{strings::util;CalendarDateTime::Format}.
15///
16/// If parameter \p{formatSpec} is empty, a default format string defined by string resource
17/// of key \b "FMTDT" is used.
18///
19/// \note
20/// This interface implementation is only available if modules \alib_strings and \alib_boxing
21/// are included in the \alibbuild.
22///
23/// @param self The box that the function was invoked on.
24/// @param formatSpec The specification of the format.
25/// @param nf A copy of the number format of the formatter (allowed to be modified).
26/// @param target The AString object receiving the formatted string.
27//==================================================================================================
28ALIB_DLL void
29FFormat_DateTime( const Box & self, const String & formatSpec, NumberFormat& nf, AString& target );
30
31} // namespace [alib::format]
32
33
34
#define ALIB_DLL
Definition alib.inl:496
#define ALIB_EXPORT
Definition alib.inl:488
ALIB_DLL void FFormat_DateTime(const Box &self, const String &formatSpec, NumberFormat &nf, AString &target)
strings::TAString< character, lang::HeapAllocator > AString
Type alias in namespace alib.
strings::TNumberFormat< character > NumberFormat
Type alias in namespace alib.
boxing::Box Box
Type alias in namespace alib.
Definition box.inl:1216
strings::TString< character > String
Type alias in namespace alib.
Definition string.inl:2381