utf8::buffer Class Reference

A simple buffer for caching values returned by Windows API. More...

#include <winutf8.h>

Public Member Functions
	buffer (size_t size_)
	~buffer ()
	Destructor.
	buffer (const buffer &other)
	Copy constructor.
buffer &	operator= (const buffer &rhs)
	Principal assignment operator.
buffer &	operator= (const std::string &rhs)
	String assignment operator.
	operator wchar_t * ()
	Return a pointer to buffer.
	operator std::string () const
	Convert buffer to an UTF-8 encoded string.
DWORD	size () const
	Return buffer size.

Detailed Description

A simple buffer for caching values returned by Windows API.

Many Windows API function return output strings as UTF-16 encoded strings.

This class provides conversion operators that make it easier to go back to UTF-8 encoded strings.

Here is a simple usage example:

utf8::buffer path (_MAX_PATH);
utf8::buffer fname (_MAX_PATH);
 
GetTempPath (path.size (), path);
GetTempFileName (path, L"ABC", 1, fname);
 
string result = fname;

Without this class, the equivalent code would be something like:

wstring wpath (_MAX_PATH, L'\0');
wstring wfname (_MAX_PATH, L'\0');
 
GetTempPath (wpath.size (), const_cast<wchar_t*>(wpath.data ()));
GetTempFileName (wpath.c_str(), L"ABC", 1, const_cast<wchar_t*>(wfname.data ()));
 
string result = narrow(wfname);

Constructor & Destructor Documentation

buffer()

utf8::buffer::buffer ( size_t  size_ )

explicit

Constructor

Parameters

size_

buffer size in characters (not bytes)

---

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

• include/utf8/winutf8.h
• src/buffer.cpp