resource_string Class Reference
[String Library]

#include <mfcstl/string/resource_string.hpp>

Inheritance diagram for resource_string:

stl_collection_tag collection_tag

List of all members.


Detailed Description

Instances of this class represent Windows string resources, and are constructed from instance identifiers.

Public Types

typedef LPCTSTR const_iterator
 The type of the const (non-mutating) iterator.
typedef UINT size_type
 The size type.

Public Member Functions

 resource_string (ms_uint_t id) stlsoft_throw_2(CMemoryException *
 Constructs an around the string loaded from the given id.
CResourceException * resource_string (HINSTANCE hinst, ms_uint_t id) stlsoft_throw_2(CMemoryException *
 Constructs an around the string loaded from the given id and hinst.
CResourceException
*CResourceException * 
resource_string (resource_string const &rhs)
 Copy constructor.
 resource_string (CString const &rhs)
 Copy constructor.
resource_string const & operator= (resource_string const &rhs)
 Copy assignment operator.
resource_string const & operator= (CString const &rhs)
 Copy assignment operator.
const_iterator begin () const
 Begins the iteration.
const_iterator end () const
 Ends the iteration.
size_type size () const
 Returns the number of elements in the sequence.
size_type length () const
 Returns the number of elements in the sequence.
bool empty () const
 Indicates whether the string is empty.
LPCTSTR c_str () const
 Returns a pointer to constant data representing the managed string.
LPCTSTR data () const
 Returns a possibly unterminated pointer to constant data representing the managed string.

Member Typedef Documentation

typedef LPCTSTR const_iterator

The type of the const (non-mutating) iterator.

typedef UINT size_type

The size type.


Constructor & Destructor Documentation

resource_string ( ms_uint_t  id  )  [inline, explicit]

Constructs an around the string loaded from the given id.

Parameters:
id identifier of the string resource to load

CResourceException* resource_string ( HINSTANCE  hinst,
ms_uint_t  id 
)

Constructs an around the string loaded from the given id and hinst.

Parameters:
hinst The module from which to load the string
id identifier of the string resource to load

CResourceException* CResourceException* resource_string ( resource_string const &  rhs  ) 

Copy constructor.

Parameters:
rhs The instance from which to copy-construct

resource_string ( CString const &  rhs  ) 

Copy constructor.

Parameters:
rhs The instance from which to copy-construct


Member Function Documentation

resource_string const& operator= ( resource_string const &  rhs  ) 

Copy assignment operator.

Parameters:
rhs The instance from which to copy-assign

resource_string const& operator= ( CString const &  rhs  ) 

Copy assignment operator.

Parameters:
rhs The instance from which to copy-assign

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

size_type size (  )  const

Returns the number of elements in the sequence.

size_type length (  )  const

Returns the number of elements in the sequence.

bool empty (  )  const

Indicates whether the string is empty.

LPCTSTR c_str (  )  const

Returns a pointer to constant data representing the managed string.

LPCTSTR data (  )  const

Returns a possibly unterminated pointer to constant data representing the managed string.


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

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