bslfmt::basic_format_args< t_CONTEXT > Class Template Reference

#include <bslfmt_format_args.h>

Detailed Description

template<class t_CONTEXT>
class bslfmt::basic_format_args< t_CONTEXT >

A class intended to provide access to formatting arguments. This should not be constructed directly but indirectly using one of the make_format_args or the make_wformat_args functions.

Note

Note that this type has reference semantics and users must ensure that this type does not outlive the arguments used in its construction.

See bslfmt_format_args

Public Member Functions
	basic_format_args () BSLS_KEYWORD_NOEXCEPT
template<class... t_ARGS>
	basic_format_args (const Format_ArgsStore< t_CONTEXT, t_ARGS... > &store) BSLS_KEYWORD_NOEXCEPT
basic_format_arg< t_CONTEXT >	get (size_t pos) const BSLS_KEYWORD_NOEXCEPT

Friends
class	Format_ArgsUtil

Constructor & Destructor Documentation

basic_format_args() [1/2]

template<class t_CONTEXT >

bslfmt::basic_format_args< t_CONTEXT >::basic_format_args ( )

inline

Create a basic_format_args object which contains no arguments.

basic_format_args() [2/2]

template<class t_CONTEXT >

template<class... t_ARGS>

bslfmt::basic_format_args< t_CONTEXT >::basic_format_args ( const Format_ArgsStore< t_CONTEXT, t_ARGS... > &  store )

inline

Create a basic_format_args object which contains the arguments held by the specified store. Typically this constructor would be called using the return value of make_format_args or of make_wformat_args .

Member Function Documentation

get()

template<class t_CONTEXT >

basic_format_arg< t_CONTEXT > bslfmt::basic_format_args< t_CONTEXT >::get ( size_t  pos ) const

inline

Return the argument held at the position given by the specified pos. If pos >= size() then a default-constructed basic_format_arg is returned.

Friends And Related Symbol Documentation

Format_ArgsUtil

template<class t_CONTEXT >

friend class Format_ArgsUtil

friend

---

The documentation for this class was generated from the following file:

• bslfmt_format_args.h