std::wstring_convert< _Codecvt, _Elem, _Wide_alloc, _Byte_alloc >(3)
                                                      Library Functions Manual

NAME
       std::wstring_convert< _Codecvt, _Elem, _Wide_alloc, _Byte_alloc > -
       String conversions.


SYNOPSIS
       #include <locale>

   Public Types
       typedef basic_string< char, char_traits< char >, _Byte_alloc >
           byte_string
       typedef wide_string::traits_type::int_type int_type
       typedef _Codecvt::state_type state_type
       typedef basic_string< _Elem, char_traits< _Elem >, _Wide_alloc >
           wide_string

   Public Member Functions
       wstring_convert ()
           Default constructor.
       wstring_convert (_Codecvt *__pcvt)
       wstring_convert (_Codecvt *__pcvt, state_type __state)
       wstring_convert (const byte_string &__byte_err, const wide_string
           &__wide_err=wide_string())
       wstring_convert (const wstring_convert &)=delete
       size_t converted () const noexcept
           The number of elements successfully converted in the last
           conversion.
       wstring_convert & operator= (const wstring_convert &)=delete
       state_type state () const
           The final conversion state of the last conversion.


           wide_string from_bytes (char __byte)
               Convert from bytes.
           wide_string from_bytes (const char *__ptr)
               Convert from bytes.
           wide_string from_bytes (const byte_string &__str)
               Convert from bytes.
           wide_string from_bytes (const char *__first, const char *__last)
               Convert from bytes.


           byte_string to_bytes (_Elem __wchar)
               Convert to bytes.
           byte_string to_bytes (const _Elem *__ptr)
               Convert to bytes.
           byte_string to_bytes (const wide_string &__wstr)
               Convert to bytes.
           byte_string to_bytes (const _Elem *__first, const _Elem *__last)
               Convert to bytes.

Detailed Description
   template<typename _Codecvt, typename _Elem = wchar_t, typename _Wide_alloc
       = allocator<_Elem>, typename _Byte_alloc = allocator<char>>
       class std::wstring_convert< _Codecvt, _Elem, _Wide_alloc, _Byte_alloc
       >"String conversions.

Constructor & Destructor Documentation
   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> std::wstring_convert< _Codecvt, _Elem, _Wide_alloc,
       _Byte_alloc >::wstring_convert () [inline]
       Default constructor.

   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> std::wstring_convert< _Codecvt, _Elem, _Wide_alloc,
       _Byte_alloc >::wstring_convert (_Codecvt * __pcvt) [inline],
       [explicit]
       Constructor.

       Parameters
           __pcvt The facet to use for conversions.

       Takes ownership of __pcvt and will delete it in the destructor.

   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> std::wstring_convert< _Codecvt, _Elem, _Wide_alloc,
       _Byte_alloc >::wstring_convert (_Codecvt * __pcvt, state_type __state)
       [inline]
       Construct with an initial converstion state.

       Parameters
           __pcvt The facet to use for conversions.
           __state Initial conversion state.

       Takes ownership of __pcvt and will delete it in the destructor. The
       object's conversion state will persist between conversions.

   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> std::wstring_convert< _Codecvt, _Elem, _Wide_alloc,
       _Byte_alloc >::wstring_convert (const byte_string & __byte_err, const
       wide_string & __wide_err = wide_string()) [inline],  [explicit]
       Construct with error strings.

       Parameters
           __byte_err A string to return on failed conversions.
           __wide_err A wide string to return on failed conversions.

Member Function Documentation
   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> size_t std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::converted () const [inline],  [noexcept]
       The number of elements successfully converted in the last conversion.

   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> wide_string std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::from_bytes (char __byte) [inline]
       Convert from bytes.

       References std::forward(), and std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::from_bytes().

       Referenced by std::wstring_convert< _Codecvt, _Elem, _Wide_alloc,
       _Byte_alloc >::from_bytes(), std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::from_bytes(), and std::wstring_convert<
       _Codecvt, _Elem, _Wide_alloc, _Byte_alloc >::from_bytes().

   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> wide_string std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::from_bytes (const byte_string & __str)
       [inline]
       Convert from bytes.

       References std::forward(), and std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::from_bytes().

   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> wide_string std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::from_bytes (const char * __first, const
       char * __last) [inline]
       Convert from bytes.

       References std::forward(), and std::basic_string< _CharT, _Traits,
       _Alloc >::get_allocator().

   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> wide_string std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::from_bytes (const char * __ptr) [inline]
       Convert from bytes.

       References std::forward(), and std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::from_bytes().

   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> state_type std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::state () const [inline]
       The final conversion state of the last conversion.

   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> byte_string std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::to_bytes (_Elem __wchar) [inline]
       Convert to bytes.

       References std::forward(), and std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::to_bytes().

       Referenced by std::wstring_convert< _Codecvt, _Elem, _Wide_alloc,
       _Byte_alloc >::to_bytes(), std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::to_bytes(), and std::wstring_convert<
       _Codecvt, _Elem, _Wide_alloc, _Byte_alloc >::to_bytes().

   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> byte_string std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::to_bytes (const _Elem * __first, const
       _Elem * __last) [inline]
       Convert to bytes.

       References std::forward(), and std::basic_string< _CharT, _Traits,
       _Alloc >::get_allocator().

   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> byte_string std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::to_bytes (const _Elem * __ptr) [inline]
       Convert to bytes.

       References std::forward(), std::basic_string< _CharT, _Traits, _Alloc
       >::length(), and std::wstring_convert< _Codecvt, _Elem, _Wide_alloc,
       _Byte_alloc >::to_bytes().

   template<typename _Codecvt , typename _Elem  = wchar_t, typename
       _Wide_alloc  = allocator<_Elem>, typename _Byte_alloc  =
       allocator<char>> byte_string std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::to_bytes (const wide_string & __wstr)
       [inline]
       Convert to bytes.

       References std::forward(), and std::wstring_convert< _Codecvt, _Elem,
       _Wide_alloc, _Byte_alloc >::to_bytes().


Author
       Generated automatically by Doxygen for libstdc++ from the source code.

                                   libstdc++
          std::wstring_convert< _Codecvt, _Elem, _Wide_alloc, _Byte_alloc >(3)