std::basic_string< CharT, Traits, Alloc > Class Template Reference
[Containers, Sequences]

Managing sequences of characters and character-like objects. More...

#include <string>

Inheritance diagram for std::basic_string< CharT, Traits, Alloc >:

[legend]List of all members.

Public Member Functions
	basic_string ()
	Default constructor creates an empty string.
	basic_string (const Alloc &a)
	Construct an empty string using allocator a.
	basic_string (const basic_string &str)
	Construct string with copy of value of str.
	basic_string (const basic_string &str, size_type position, size_type n=npos)
	Construct string as copy of a substring.
	basic_string (const basic_string &str, size_type position, size_type n, const Alloc &a)
	Construct string as copy of a substring.
	basic_string (const CharT *s, size_type n, const Alloc &a=Alloc())
	Construct string initialized by a character array.
	basic_string (const CharT *s, const Alloc &a=Alloc())
	Construct string as copy of a C string.
	basic_string (size_type n, CharT c, const Alloc &a=Alloc())
	Construct string as multiple characters.
template<class InputIterator>
	basic_string (InputIterator __beg, InputIterator __end, const Alloc &a=Alloc())
	Construct string as copy of a range.
	~basic_string ()
	Destroy the string instance.
basic_string &	operator= (const basic_string &str)
	Assign the value of str to this string.
basic_string &	operator= (const CharT *s)
	Copy contents of s into this string.
basic_string &	operator= (CharT c)
	Set value to string of length 1.
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
reverse_iterator	rbegin ()
const_reverse_iterator	rbegin () const
reverse_iterator	rend ()
const_reverse_iterator	rend () const
size_type	size () const
	null-termination.
size_type	length () const
	null-termination.
size_type	max_size () const
	Returns the size() of the largest possible string.
void	resize (size_type n, CharT c)
	Resizes the string to the specified number of characters.
void	resize (size_type n)
	Resizes the string to the specified number of characters.
size_type	capacity () const
void	reserve (size_type __res_arg=0)
	Attempt to preallocate enough memory for specified number of characters.
void	clear ()
bool	empty () const
const_reference	operator[] (size_type position) const
	Subscript access to the data contained in the string.
reference	operator[] (size_type position)
	Subscript access to the data contained in the string.
const_reference	at (size_type n) const
	Provides access to the data contained in the string.
reference	at (size_type n)
	Provides access to the data contained in the string.
basic_string &	operator+= (const basic_string &str)
	Append a string to this string.
basic_string &	operator+= (const CharT *s)
	Append a C string.
basic_string &	operator+= (CharT c)
	Append a character.
basic_string &	append (const basic_string &str)
	Append a string to this string.
basic_string &	append (const basic_string &str, size_type position, size_type n)
	Append a substring.
basic_string &	append (const CharT *s, size_type n)
	Append a C substring.
basic_string &	append (const CharT *s)
	Append a C string.
basic_string &	append (size_type n, CharT c)
	Append multiple characters.
template<class InputIterator>
basic_string &	append (InputIterator first, InputIterator last)
	Append a range of characters.
void	push_back (CharT c)
	Append a single character.
basic_string &	assign (const basic_string &str)
	Set value to contents of another string.
basic_string &	assign (const basic_string &str, size_type position, size_type n)
	Set value to a substring of a string.
basic_string &	assign (const CharT *s, size_type n)
	Set value to a C substring.
basic_string &	assign (const CharT *s)
	Set value to contents of a C string.
basic_string &	assign (size_type n, CharT c)
	Set value to multiple characters.
template<class InputIterator>
basic_string &	assign (InputIterator first, InputIterator last)
	Set value to a range of characters.
void	insert (iterator __p, size_type n, CharT c)
	Insert multiple characters.
template<class InputIterator>
void	insert (iterator __p, InputIterator __beg, InputIterator __end)
	Insert a range of characters.
basic_string &	insert (size_type position1, const basic_string &str)
	Insert value of a string.
basic_string &	insert (size_type position1, const basic_string &str, size_type position2, size_type n)
	Insert a substring.
basic_string &	insert (size_type position, const CharT *s, size_type n)
	Insert a C substring.
basic_string &	insert (size_type position, const CharT *s)
	Insert a C string.
basic_string &	insert (size_type position, size_type n, CharT c)
	Insert multiple characters.
iterator	insert (iterator __p, CharT c)
	Insert one character.
basic_string &	erase (size_type position=0, size_type n=npos)
	Remove characters.
iterator	erase (iterator position)
	Remove one character.
iterator	erase (iterator first, iterator last)
	Remove a range of characters.
basic_string &	replace (size_type position, size_type n, const basic_string &str)
	Replace characters with value from another string.
basic_string &	replace (size_type position1, size_type n1, const basic_string &str, size_type position2, size_type n2)
	Replace characters with value from another string.
basic_string &	replace (size_type position, size_type n1, const CharT *s, size_type n2)
	Replace characters with value of a C substring.
basic_string &	replace (size_type position, size_type n1, const CharT *s)
	Replace characters with value of a C string.
basic_string &	replace (size_type position, size_type n1, size_type n2, CharT c)
	Replace characters with multiple characters.
basic_string &	replace (iterator __i1, iterator __i2, const basic_string &str)
	Replace range of characters with string.
basic_string &	replace (iterator __i1, iterator __i2, const CharT *s, size_type n)
	Replace range of characters with C substring.
basic_string &	replace (iterator __i1, iterator __i2, const CharT *s)
	Replace range of characters with C string.
basic_string &	replace (iterator __i1, iterator __i2, size_type n, CharT c)
	Replace range of characters with multiple characters.
template<class InputIterator>
basic_string &	replace (iterator __i1, iterator __i2, InputIterator __k1, InputIterator __k2)
	Replace range of characters with range.
size_type	copy (CharT *s, size_type n, size_type position=0) const
	Copy substring into C string.
void	swap (basic_string &s)
	Swap contents with another string.
const CharT *	c_str () const
	Return const pointer to null-terminated contents.
const CharT *	data () const
	Return const pointer to contents.
allocator_type	get_allocator () const
	Return copy of allocator used to construct this string.
size_type	find (const CharT *s, size_type position, size_type n) const
	Find position of a C substring.
size_type	find (const basic_string &str, size_type position=0) const
	Find position of a string.
size_type	find (const CharT *s, size_type position=0) const
	Find position of a C string.
size_type	find (CharT c, size_type position=0) const
	Find position of a character.
size_type	rfind (const basic_string &str, size_type position=npos) const
	Find last position of a string.
size_type	rfind (const CharT *s, size_type position, size_type n) const
	Find last position of a C substring.
size_type	rfind (const CharT *s, size_type position=npos) const
	Find last position of a C string.
size_type	rfind (CharT c, size_type position=npos) const
	Find last position of a character.
size_type	find_first_of (const basic_string &str, size_type position=0) const
	Find position of a character of string.
size_type	find_first_of (const CharT *s, size_type position, size_type n) const
	Find position of a character of C substring.
size_type	find_first_of (const CharT *s, size_type position=0) const
	Find position of a character of C string.
size_type	find_first_of (CharT c, size_type position=0) const
	Find position of a character.
size_type	find_last_of (const basic_string &str, size_type position=npos) const
	Find last position of a character of string.
size_type	find_last_of (const CharT *s, size_type position, size_type n) const
	Find last position of a character of C substring.
size_type	find_last_of (const CharT *s, size_type position=npos) const
	Find last position of a character of C string.
size_type	find_last_of (CharT c, size_type position=npos) const
	Find last position of a character.
size_type	find_first_not_of (const basic_string &str, size_type position=0) const
	Find position of a character not in string.
size_type	find_first_not_of (const CharT *s, size_type position, size_type n) const
	Find position of a character not in C substring.
size_type	find_first_not_of (const CharT *s, size_type position=0) const
	Find position of a character not in C string.
size_type	find_first_not_of (CharT c, size_type position=0) const
	Find position of a different character.
size_type	find_last_not_of (const basic_string &str, size_type position=npos) const
	Find last position of a character not in string.
size_type	find_last_not_of (const CharT *s, size_type position, size_type n) const
	Find last position of a character not in C substring.
size_type	find_last_not_of (const CharT *s, size_type position=npos) const
	Find position of a character not in C string.
size_type	find_last_not_of (CharT c, size_type position=npos) const
	Find last position of a different character.
basic_string	substr (size_type position=0, size_type n=npos) const
	Get a substring.
int	compare (const basic_string &str) const
	Compare to a string.
int	compare (size_type position, size_type n, const basic_string &str) const
	Compare substring to a string.
int	compare (size_type position1, size_type n1, const basic_string &str, size_type position2, size_type n2) const
	Compare substring to a substring.
int	compare (const CharT *s) const
	Compare to a C string.
int	compare (size_type position, size_type n1, const CharT *s) const
	Compare substring to a C string.
int	compare (size_type position, size_type n1, const CharT *s, size_type n2) const
	Compare substring against a character array.

---

Detailed Description

template<typename CharT, typename Traits, typename Alloc>
class std::basic_string< CharT, Traits, Alloc >

Managing sequences of characters and character-like objects.

Meets the requirements of a container, a reversible container, and a sequence. Of the optional sequence requirements, only push_back, at, and array access are supported.

Todo:

Doc me! See docs/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more.

Definition at line 110 of file basic_string.h.

---

Constructor & Destructor Documentation

template<typename CharT, typename Traits, typename Alloc> std::basic_string< CharT, Traits, Alloc >::basic_string (   )  [inline]

Default constructor creates an empty string. Definition at line 1972 of file basic_string.h. Referenced by std::basic_string< char >::substr().

template<typename CharT, typename Traits, typename Alloc> std::basic_string< CharT, Traits, Alloc >::basic_string (  const Alloc &  a  )  [explicit]

Construct an empty string using allocator a. Definition at line 192 of file basic_string.tcc.

template<typename CharT, typename Traits, typename Alloc> std::basic_string< CharT, Traits, Alloc >::basic_string (  const basic_string< CharT, Traits, Alloc > &  str  )

Construct string with copy of value of str. Parameters: str  Source string. Definition at line 184 of file basic_string.tcc.

template<typename CharT, typename Traits, typename Alloc> std::basic_string< CharT, Traits, Alloc >::basic_string (  const basic_string< CharT, Traits, Alloc > &  str, size_type  position, size_type  n = npos )

Construct string as copy of a substring. Parameters: str  Source string. pos  Index of first character to copy from. n  Number of characters to copy (default remainder). Definition at line 198 of file basic_string.tcc.

template<typename CharT, typename Traits, typename Alloc> std::basic_string< CharT, Traits, Alloc >::basic_string (  const basic_string< CharT, Traits, Alloc > &  str, size_type  position, size_type  n, const Alloc &  a )

Construct string as copy of a substring. Parameters: str  Source string. pos  Index of first character to copy from. n  Number of characters to copy. a  Allocator to use. Definition at line 208 of file basic_string.tcc.

template<typename CharT, typename Traits, typename Alloc> std::basic_string< CharT, Traits, Alloc >::basic_string (  const CharT *  s, size_type  n, const Alloc &  a = Alloc() )

Construct string initialized by a character array. Parameters: s  Source character array. n  Number of characters to copy. a  Allocator to use (default is default allocator). NB: s must have at least n characters, '' has no special meaning. Definition at line 220 of file basic_string.tcc.

template<typename CharT, typename Traits, typename Alloc> std::basic_string< CharT, Traits, Alloc >::basic_string (  const CharT *  s, const Alloc &  a = Alloc() )

Construct string as copy of a C string. Parameters: s  Source C string. a  Allocator to use (default is default allocator). Definition at line 227 of file basic_string.tcc.

template<typename CharT, typename Traits, typename Alloc> std::basic_string< CharT, Traits, Alloc >::basic_string (  size_type  n, CharT  c, const Alloc &  a = Alloc() )

Construct string as multiple characters. Parameters: n  Number of characters. c  Character to use. a  Allocator to use (default is default allocator). Definition at line 234 of file basic_string.tcc.

template<typename CharT, typename Traits, typename Alloc> template<typename InputIterator> std::basic_string< CharT, Traits, Alloc >::basic_string (  InputIterator  __beg, InputIterator  __end, const Alloc &  a = Alloc() )

Construct string as copy of a range. Parameters: beg  Start of range. end  End of range. a  Allocator to use (default is default allocator). Definition at line 242 of file basic_string.tcc.

template<typename CharT, typename Traits, typename Alloc> std::basic_string< CharT, Traits, Alloc >::~basic_string (   )  [inline]

Destroy the string instance. Definition at line 417 of file basic_string.h.

---

Member Function Documentation

template<typename CharT, typename Traits, typename Alloc> template<class InputIterator> basic_string& std::basic_string< CharT, Traits, Alloc >::append (  InputIterator  first, InputIterator  last )  [inline]

Append a range of characters. Parameters: first  Iterator referencing the first character to append. last  Iterator marking the end of the range. Returns: Reference to this string. Appends characters in the range [first,last) to this string. Definition at line 777 of file basic_string.h.

template<typename CharT, typename Traits, typename Alloc> basic_string& std::basic_string< CharT, Traits, Alloc >::append (  size_type  n, CharT  c )  [inline]

Append multiple characters. Parameters: n  The number of characters to append. c  The character to use. Returns: Reference to this string. Appends n copies of c to this string. Definition at line 764 of file basic_string.h.

template<typename CharT, typename Traits, typename Alloc> basic_string& std::basic_string< CharT, Traits, Alloc >::append (  const CharT *  s  )  [inline]

Append a C string. Parameters: s  The C string to append. Returns: Reference to this string. Definition at line 749 of file basic_string.h.

template<typename CharT, typename Traits, typename Alloc> basic_string< CharT, Traits, Alloc > & std::basic_string< CharT, Traits, Alloc >::append (  const CharT *  s, size_type  n )

Append a C substring. Parameters: s  The C string to append. n  The number of characters to append. Returns: Reference to this string. Definition at line 636 of file basic_string.tcc. References std::basic_string< CharT, Traits, Alloc >::reserve(), and std::basic_string< CharT, Traits, Alloc >::size().

template<typename CharT, typename Traits, typename Alloc> basic_string< CharT, Traits, Alloc > & std::basic_string< CharT, Traits, Alloc >::append (  const basic_string< CharT, Traits, Alloc > &  str, size_type  position, size_type  n )

Append a substring. Parameters: str  The string to append. pos  Index of the first character of str to append. n  The number of characters to append. Returns: Reference to this string. Exceptions: std::out_of_range  if pos is not a valid index. This function appends n characters from str starting at pos to this string. If n is is larger than the number of available characters in str, the remainder of str is appended. Definition at line 619 of file basic_string.tcc. References std::basic_string< CharT, Traits, Alloc >::reserve(), and std::basic_string< CharT, Traits, Alloc >::size().

template<typename CharT, typename Traits, typename Alloc> basic_string< CharT, Traits, Alloc > & std::basic_string< CharT, Traits, Alloc >::append (  const basic_string< CharT, Traits, Alloc > &  str  )

Append a string to this string. Parameters: str  The string to append. Returns: Reference to this string. Definition at line 603 of file basic_string.tcc. References std::basic_string< CharT, Traits, Alloc >::reserve(), and std::basic_string< CharT, Traits, Alloc >::size(). Referenced by std::basic_string< char >::append(), std::collate< CharT >::do_transform(), std::getline(), std::operator+(), std::basic_string< char >::operator+=(), std::operator>>(), and std::basic_string< CharT, Traits, Alloc >::resize().

template<typename CharT, typename Traits, typename Alloc> template<class InputIterator> basic_string& std::basic_string< CharT, Traits, Alloc >::assign (  InputIterator  first, InputIterator  last )  [inline]

Set value to a range of characters. Parameters: first  Iterator referencing the first character to append. last  Iterator marking the end of the range. Returns: Reference to this string. Sets value of string to characters in the range [first,last). Definition at line 866 of file basic_string.h.

template<typename CharT, typename Traits, typename Alloc> basic_string& std::basic_string< CharT, Traits, Alloc >::assign (  size_type  n, CharT  c )  [inline]

Set value to multiple characters. Parameters: n  Length of the resulting string. c  The character to use. Returns: Reference to this string. This function sets the value of this string to n copies of character c. Definition at line 853 of file basic_string.h.

template<typename CharT, typename Traits, typename Alloc> basic_string& std::basic_string< CharT, Traits, Alloc >::assign (  const CharT *  s  )  [inline]

Set value to contents of a C string. Parameters: s  The C string to use. Returns: Reference to this string. This function sets the value of this string to the value of s. The data is copied, so there is no dependence on s once the function returns. Definition at line 837 of file basic_string.h.

template<typename CharT, typename Traits, typename Alloc> basic_string< CharT, Traits, Alloc > & std::basic_string< CharT, Traits, Alloc >::assign (  const CharT *  s, size_type  n )

Set value to a C substring. Parameters: s  The C string to use. n  Number of characters to use. Returns: Reference to this string. This function sets the value of this string to the first n characters of s. If n is is larger than the number of available characters in s, the remainder of s is used. Definition at line 265 of file basic_string.tcc.

template<typename CharT, typename Traits, typename Alloc> basic_string& std::basic_string< CharT, Traits, Alloc >::assign (  const basic_string< CharT, Traits, Alloc > &  str, size_type  position, size_type  n )  [inline]

Set value to a substring of a string. Parameters: str  The string to use. pos  Index of the first character of str. n  Number of characters to use. Returns: Reference to this string. Exceptions: std::out_of_range  if pos is not a valid index. This function sets this string to the substring of str consisting of n characters at pos. If n is is larger than the number of available characters in str, the remainder of str is used. Definition at line 809 of file basic_string.h.

template<typename CharT, typename Traits, typename Alloc> basic_string< CharT, Traits, Alloc > & std::basic_string< CharT, Traits, Alloc >::assign (  const basic_string< CharT, Traits, Alloc > &  str  )

Set value to contents of another string. Parameters: str  Source string to use. Returns: Reference to this string. Definition at line 249 of file basic_string.tcc. References std::basic_string< CharT, Traits, Alloc >::get_allocator(). Referenced by std::basic_string< char >::assign(), std::money_get< CharT, InIter >::do_get(), and std::basic_string< char >::operator=().

template<typename CharT, typename Traits, typename Alloc> reference std::basic_string< CharT, Traits, Alloc >::at (  size_type  n  )  [inline]

Provides access to the data contained in the string. Parameters: n  The index of the character to access. Returns: Read/write reference to the character. Exceptions: std::out_of_range  If n is an invalid index. This function provides for safer data access. The parameter is first checked that it is in the range of the string. The function throws out_of_range if the check fails. Success results in unsharing the string. Definition at line 678 of file basic_string.h.

template<typename CharT, typename Traits, typename Alloc> const_reference std::basic_string< CharT, Traits, Alloc >::at (  size_type  n  )  const [inline]

Provides access to the data contained in the string. Parameters: n  The index of the character to access. Returns: Read-only (const) reference to the character. Exceptions: std::out_of_range  If n is an invalid index. This function provides for safer data access. The parameter is first checked that it is in the range of the string. The function throws out_of_range if the check fails. Definition at line 659 of file basic_string.h.

template<typename CharT, typename Traits, typename Alloc> const_iterator std::basic_string< CharT, Traits, Alloc >::begin (   )  const [inline]

Returns a read-only (constant) iterator that points to the first character in the string. Definition at line 473 of file basic_string.h.

template<typename CharT, typename Traits, typename Alloc> iterator std::basic_string< CharT, Traits, Alloc >::begin (   )  [inline]

Returns a read/write iterator that points to the first character in the string. Unshares the string. Definition at line 462 of file basic_string.h.

template<typename CharT, typename Traits, typename Alloc> const CharT* std::basic_string< CharT, Traits, Alloc >::c_str (   )  const [inline]

Return const pointer to null-terminated contents. This is a handle to internal data. Do not modify or dire things may happen. Definition at line 1456 of file basic_string.h. Referenced by std::collate< CharT >::do_compare(), std::money_get< CharT, InIter >::do_get(), std::collate< CharT >::do_transform(), and std::locale::locale().

template<typename CharT, typename Traits, typename Alloc> size_type std::basic_string< CharT, Traits, Alloc >::capacity (   )  const [inline]

Returns the total number of characters that the string can hold before needing to allocate more memory. Definition at line 578 of file basic_string.h.

template<typename CharT, typename Traits, typename Alloc> void std::basic_string< CharT, Traits, Alloc >::clear (   )  [inline]

Erases the string, making it empty. Definition at line 604 of file basic_string.h.

template<typename CharT, typename Traits, typename Alloc> int std::basic_string< CharT, Traits, Alloc >::compare (  size_type  position, size_type  n1, const CharT *  s, size_type  n2 )  const

Compare substring against a character array. Parameters: pos1  Index of first character of substring. n1  Number of characters in substring. s  character array to compare against. n2  Number of characters of s. Returns: Integer < 0, 0, or > 0. Form the substring of this string from the n1 characters starting at pos1. Form a string from the first n2 characters of s. Returns an integer < 0 if this substring is ordered before the string from s, 0 if their values are equivalent, or > 0 if this substring is ordered after the string from s. If the lengths of this substring and n2 are different, the shorter one is ordered first. If they are the same, returns the result of traits::compare(substring.data(),s,size()); NB: s must have at least n2 characters, '' has no special meaning. Definition at line 926 of file basic_string.tcc. References std::min().

template<typename CharT, typename Traits, typename Alloc> int std::basic_string< CharT, Traits, Alloc >::compare (  size_type  position, size_type  n1, const CharT *  s )  const

Compare substring to a C string. Parameters: pos  Index of first character of substring. n1  Number of characters in substring. s  C string to compare against. Returns: Integer < 0, 0, or > 0. Form the substring of this string from the n1 characters starting at pos. Returns an integer < 0 if the substring is ordered before s, 0 if their values are equivalent, or > 0 if the substring is ordered after s. If the lengths of s and the substring are different, the shorter one is ordered first. If they are the same, returns the result of traits::compare(substring.data(),s,size()); Definition at line 910 of file basic_string.tcc. References std::min().

template<typename CharT, typename Traits, typename Alloc> int std::basic_string< CharT, Traits, Alloc >::compare (  const CharT *  s  )  const

Compare to a C string. Parameters: s  C string to compare against. Returns: Integer < 0, 0, or > 0. Returns an integer < 0 if this string is ordered before s, 0 if their values are equivalent, or > 0 if this string is ordered after s. If the lengths of s and this string are different, the shorter one is ordered first. If they are the same, returns the result of traits::compare(data(),s,size()); Definition at line 895 of file basic_string.tcc. References std::min(), and std::basic_string< CharT, Traits, Alloc >::size().

template<typename CharT, typename Traits, typename Alloc> int std::basic_string< CharT, Traits, Alloc >::compare (  size_type  position1, size_type  n1, const basic_string< CharT, Traits, Alloc > &  str, size_type  position2, size_type  n2 )  const

Compare substring to a substring. Parameters: pos1  Index of first character of substring. n1  Number of characters in substring. str  String to compare against. pos2  Index of first character of substring of str. n2  Number of characters in substring of str. Returns: Integer < 0, 0, or > 0. Form the substring of this string from the n1 characters starting at pos1. Form the substring of str from the n2 characters starting at pos2. Returns an integer < 0 if this substring is ordered before the substring of str, 0 if their values are equivalent, or > 0 if this substring is ordered after the substring of str. If the lengths of the substring of str and this substring are different, the shorter one is ordered first. If they are the same, returns the result of traits::compare(substring.data(),str.substr(pos2,n2).data(),size()); Definition at line 877 of file basic_string.tcc. References std::basic_string< CharT, Traits, Alloc >::data(), and std::min().

template<typename CharT, typename Traits, typename Alloc> int std::basic_string< CharT, Traits, Alloc >::compare (  size_type  position, size_type  n, const basic_string< CharT, Traits, Alloc > &  str )  const

Compare substring to a string. Parameters: pos  Index of first character of substring. n  Number of characters in substring. str  String to compare against. Returns: Integer < 0, 0, or > 0. Form the substring of this string from the n characters starting at pos. Returns an integer < 0 if the substring is ordered before str, 0 if their values are equivalent, or > 0 if the substring is ordered after str. If the lengths of str and the substring are different, the shorter one is ordered first. If they are the same, returns the result of traits::compare(substring.data(),str.data(),size()); Definition at line 862 of file basic_string.tcc. References std::basic_string< CharT, Traits, Alloc >::data(), std::min(), and std::basic_string< CharT, Traits, Alloc >::size().

template<typename CharT, typename Traits, typename Alloc> int std::basic_string< CharT, Traits, Alloc >::compare (  const basic_string< CharT, Traits, Alloc > &  str  )  const [inline]

Compare to a string. Parameters: str  String to compare against. Returns: Integer < 0, 0, or > 0. Returns an integer < 0 if this string is ordered before str, 0 if their values are equivalent, or > 0 if this string is ordered after str. If the lengths of str and this string are different, the shorter one is ordered first. If they are the same, returns the result of traits::compare(data(),str.data(),size()); Definition at line 1858 of file basic_string.h. Referenced by std::operator!=(), std::operator<(), std::operator<=(), std::operator==(), std::operator>(), and std::operator>=().

template<typename CharT, typename Traits, typename Alloc> basic_string< CharT, Traits, Alloc >::size_type std::basic_string< CharT, Traits, Alloc >::copy (  CharT *  s, size_type  n, size_type  position = 0 )  const

Copy substring into C string. Parameters: s  C string to copy value into. n  Number of characters to copy. pos  Index of first character to copy. Returns: Number of characters actually copied Exceptions: std::out_of_range  If pos > size(). Copies up to n characters starting at pos into the C string s. If pos is greater than size(), out_of_range is thrown. Definition at line 678 of file basic_string.tcc.

template<typename CharT, typename Traits, typename Alloc> const CharT* std::basic_string< CharT, Traits, Alloc >::data (   )  const [inline]