bstr Class Reference
[COM Utility Library]

#include <comstl/string/bstr.hpp>

List of all members.


Detailed Description

Facade for the COM BSTR type.

Public Types

Member Types
typedef bstr class_type
typedef cs_char_o_t char_type
typedef char_type value_type
typedef char_type * pointer
typedef char_type const * const_pointer
typedef char_type & reference
typedef char_type const & const_reference
typedef cs_ptrdiff_t difference_type
typedef size_t size_type
typedef cs_ptrdiff_t ssize_type
typedef bool bool_type
typedef pointer iterator
typedef const_pointer const_iterator
typedef BSTR resource_type

Public Member Functions

Construction
 bstr ()
 bstr (char const *s, ssize_type len=-1)
 bstr (wchar_t const *s, ssize_type len=-1)
 bstr (size_type n, char_type ch)
 bstr (class_type const &rhs)
 Copy constructor.
 bstr (class_type const &rhs, size_type pos, size_type len)
 ~bstr () throw ()
class_typeoperator= (class_type const &rhs)
 Copies the given instance.
class_typeassign (char const *s, ssize_type len=-1)
class_typeassign (wchar_t const *s, ssize_type len=-1)
class_typeassign (const_iterator from, const_iterator to)
class_typeoperator= (char const *s)
class_typeoperator= (wchar_t const *s)
class_typeattach (BSTR bstr)
BSTR detach ()
void clear ()
Operations
class_typeappend (class_type const &s, ssize_type len=-1)
class_typeappend (wchar_t const *s, ssize_type len=-1)
class_typeoperator+= (class_type const &s)
class_typeoperator+= (wchar_t const *s)
Accessors
const_pointer data () const
const_pointer c_str () const
size_type length () const
size_type size () const
bool_type empty () const
BSTR get () const
reference operator[] (size_type)
const_reference operator[] (size_type) const
const_pointer * NonDestructiveAddress () const
BSTR * NonDestructiveAddress ()
BSTR * DestructiveAddress ()
Iteration
iterator begin ()
 Begins the iteration.
iterator end ()
 Ends the iteration.
const_iterator begin () const
 Begins the iteration.
const_iterator end () const
 Ends the iteration.
Comparison
bool_type equal (class_type const &rhs) const
 Evaluates whether the value is equivalent to the given argument.
bool_type equal (BSTR const &rhs) const
 Evaluates whether the value is equivalent to the given argument.
Operations
void swap (class_type &rhs) throw ()
 Swaps the contents with the given instance.
void swap (BSTR &rhs) throw ()
 Swaps the contents with the given BSTR.

Constructor & Destructor Documentation

bstr ( class_type const &  rhs  ) 

Copy constructor.


Member Function Documentation

class_type& operator= ( class_type const &  rhs  ) 

Copies the given instance.

iterator begin (  ) 

Begins the iteration.

Returns:
An iterator representing the start of the sequence

iterator end (  ) 

Ends the iteration.

Returns:
An iterator representing the end of the sequence

const_iterator begin (  )  const

Begins the iteration.

Returns:
A non-mutable (const) iterator representing the start of the sequence

const_iterator end (  )  const

Ends the iteration.

Returns:
A non-mutable (const) iterator representing the end of the sequence

bool_type equal ( class_type const &  rhs  )  const

Evaluates whether the value is equivalent to the given argument.

bool_type equal ( BSTR const &  rhs  )  const

Evaluates whether the value is equivalent to the given argument.

void swap ( class_type rhs  )  throw ()

Swaps the contents with the given instance.

void swap ( BSTR &  rhs  )  throw ()

Swaps the contents with the given BSTR.


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

Generated on Thu Jun 10 08:58:26 2010 for STLSoft by  doxygen 1.5.6