ccombstr_veneer Class Reference
[String Library]

#include <atlstl/string/ccombstr_veneer.hpp>

List of all members.

---

Detailed Description

Applies standard string (std::basic_string) interface to the CComBSTR class.

This class adapts the ATL string type CComBSTR to express a standard String-like interface

Public Types
typedef OLECHAR	value_type
	The value type.
typedef LPOLESTR	iterator
	The mutating iterator type.
typedef LPCOLESTR	const_iterator
	The non-mutating (const) iterator type.
typedef LPOLESTR	pointer
	The pointer type.
typedef LPCOLESTR	const_pointer
	The pointer-to-const type.
typedef OLECHAR &	reference
	The reference type.
typedef OLECHAR const &	const_reference
	The reference-to-const type.
typedef size_t	size_type
	The size type.
typedef as_ptrdiff_t	difference_type
	The difference type.
Public Member Functions
	ccombstr_veneer ()
	Default constructor.
	ccombstr_veneer (class_type const &rhs)
	Copy constructor.
	ccombstr_veneer (CComBSTR const &rhs)
	Copy constructor.
	ccombstr_veneer (LPCSTR s)
	Construct from an ANSI string.
	ccombstr_veneer (LPCWSTR s)
	Construct from a Unicode string.
	ccombstr_veneer (LPCOLESTR from, LPCOLESTR to)
	Construct from a range.
	ccombstr_veneer (size_type length, LPCOLESTR from)
	Construct from a range.
	ccombstr_veneer (size_t cch, OLECHAR ch)
class_type const &	operator= (class_type const &rhs)
	Copy assignment operator.
class_type const &	operator= (CComBSTR const &rhs)
	Copy assignment operator.
class_type const &	operator= (LPCSTR s)
	Assignment operator.
class_type const &	operator= (LPCWSTR s)
	Assignment operator.
const_iterator	begin () const
	Begins the iteration.
const_iterator	end () const
	Ends the iteration.
reference	operator[] (size_type index)
const_reference	operator[] (size_type index) const
void	swap (class_type &rhs)
CComBSTR &	get_base_type ()
	Provides access to the underlying CComBSTR type.
CComBSTR const &	get_base_type () const
	Provides access to the underlying CComBSTR type.
size_type	length () const
	Returns the number of elements in the sequence.
size_type	size () const
	Returns the number of elements in the sequence.
bool	empty () const
	Indicates whether the sequence is empty.
const_pointer	c_str () const
	Returns a pointer to constant data representing the managed string.
const_pointer	data () const
	Returns a pointer to constant data representing the managed string.

---

Member Typedef Documentation

typedef OLECHAR value_type

The value type.

typedef LPOLESTR iterator

The mutating iterator type.

typedef LPCOLESTR const_iterator

The non-mutating (const) iterator type.

typedef LPOLESTR pointer

The pointer type.

typedef LPCOLESTR const_pointer

The pointer-to-const type.

typedef OLECHAR& reference

The reference type.

typedef OLECHAR const& const_reference

The reference-to-const type.

typedef size_t size_type

The size type.

typedef as_ptrdiff_t difference_type

The difference type.

---

Constructor & Destructor Documentation

ccombstr_veneer

(

)

Default constructor.

ccombstr_veneer

(

class_type const &

rhs

)

Copy constructor.

ccombstr_veneer

(

CComBSTR const &

rhs

)

[explicit]

Copy constructor.

ccombstr_veneer

(

LPCSTR

s

)

[explicit]

Construct from an ANSI string.

ccombstr_veneer

(

LPCWSTR

s

)

[explicit]

Construct from a Unicode string.

ccombstr_veneer	(	LPCOLESTR	from,
		LPCOLESTR	to
	)

Construct from a range.

ccombstr_veneer	(	size_type	length,
		LPCOLESTR	from
	)

Construct from a range.

---

Member Function Documentation

class_type const& operator=

(

class_type const &

rhs

)

Copy assignment operator.

class_type const& operator=

(

CComBSTR const &

rhs

)

Copy assignment operator.

class_type const& operator=

(

LPCSTR

s

)

Assignment operator.

class_type const& operator=

(

LPCWSTR

s

)

Assignment operator.

const_iterator begin

(

)

const

Begins the iteration.

Returns:

An iterator representing the start of the sequence

const_iterator end

(

)

const

Ends the iteration.

Returns:

An iterator representing the end of the sequence

CComBSTR& get_base_type

(

)

Provides access to the underlying CComBSTR type.

CComBSTR const& get_base_type

(

)

const

Provides access to the underlying CComBSTR type.

size_type length

(

)

const

Returns the number of elements in the sequence.

Referenced by atlstl::c_str_len().

size_type size

(

)

const

Returns the number of elements in the sequence.

bool empty

(

)

const

Indicates whether the sequence is empty.

Referenced by atlstl::c_str_ptr_null().

const_pointer c_str

(

)

const

Returns a pointer to constant data representing the managed string.

Referenced by atlstl::c_str_ptr(), atlstl::c_str_ptr_null(), and atlstl::operator<<().

const_pointer data

(

)

const

Returns a pointer to constant data representing the managed string.

Referenced by atlstl::c_str_data().

---

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

• atlstl/string/ccombstr_veneer.hpp