ALib C++ Library
Library Version: 2510 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
loadtokens.inl
Go to the documentation of this file.
1//==================================================================================================
2/// \file
3/// This header-file is part of module \alib_strings 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#if DOXYGEN
11//==========================================================================================
12/// Shortcut to the sibling function \alib{strings::util;LoadResourcedTokens} that accepts a module
13/// and uses its resource pool and resource category.
14///
15/// @param module The \alibcamp to load the resource from.
16/// @param resourceName The resource name.
17/// @param target The table to fill.
18/// @param dbgSizeVerifier This parameter has to be specified only in debug comilations and
19/// provides the expected size of the resourced table.
20/// To be surrounded by macro #ALIB_DBG (not to be given in
21/// release-builds.)
22/// @param outerSeparator The character that separates the entries.
23/// Defaults to <c>','</c>.
24/// @param innerSeparator The character that separates the values of an entry.
25/// Defaults to <c>' '</c> (space).
26///
27/// \par Module Dependencies
28/// This method is only available if module \alib_camp is included in the \alibbuild.
29//==========================================================================================
30inline
32 const NString& resourceName,
34 int dbgSizeVerifier,
35 character outerSeparator = ',',
36 character innerSeparator = ' ' );
37#else
38inline
40 const NString& resourceName,
42 ALIB_DBG( int dbgSizeVerifier, )
43 character outerSeparator = ',',
44 character innerSeparator = ' ' )
45{
46 LoadResourcedTokens( *module.GetResourcePool(), module.ResourceCategory, resourceName,
47 target, ALIB_DBG(dbgSizeVerifier,) outerSeparator, innerSeparator );
48}
49#endif // DOXYGEN
50
51} // namespace [alib::strings::util]
52
53
54
NCString ResourceCategory
Definition camp.inl:113
SPResourcePool & GetResourcePool()
Definition camp.inl:243
#define ALIB_EXPORT
Definition alib.inl:488
#define ALIB_DBG(...)
Definition alib.inl:836
void LoadResourcedTokens(camp::Camp &module, const NString &resourceName, strings::util::Token *target, int dbgSizeVerifier, character outerSeparator=',', character innerSeparator=' ')
strings::TString< nchar > NString
Type alias in namespace alib.
Definition string.inl:2390
characters::character character
Type alias in namespace alib.