--- name: "std::strstreambuf" section: "3" platform: "linux" package: "libstdc++5-3.3-doc" version: "1:3.3.6-15" release: "Debian 4.0 (Etch)" platforms: ["linux"] url: "https://new.carta.tech/std::strstreambuf" --- # std::strstreambuf(3) ## NAME std::strstreambuf - ## SYNOPSIS Inherits **std::basic\_streambuf\< CharT, Traits \>\< char, std::char\_traits\< char \> \>**. **char\_type** **M\_pback** \[**S\_pback\_size**\]\ **char\_type** \* **M\_pback\_cur\_save**\ **char\_type** \* **M\_pback\_end\_save**\ bool **M\_pback\_init**\ static const size\_t **S\_pback\_size**\ ### Public Types typedef **char\_traits**\< char \> **Traits**\ typedef **basic\_streambuf**\< char, **Traits** \> **Base**\ typedef CharT **char\_type**\ typedef **Traits** **traits\_type**\ typedef traits\_type::int\_type **int\_type**\ typedef traits\_type::pos\_type **pos\_type**\ typedef traits\_type::off\_type **off\_type**\ typedef **ctype**\< **char\_type** \> **ctype\_type**\ typedef **basic\_streambuf**\< **char\_type**, **traits\_type** \> **streambuf\_type**\ typedef traits\_type::state\_type **state\_type**\ ### Public Member Functions **strstreambuf** (**streamsize** initial\_capacity=0)\ **strstreambuf** (void \*(\***alloc**)(size\_t), void(\*\_\_free)(void \*))\ **strstreambuf** (char \*\_\_get, **streamsize** n, char \*\_\_put=0)\ **strstreambuf** (signed char \*\_\_get, **streamsize** n, signed char \*\_\_put=0)\ **strstreambuf** (unsigned char \*\_\_get, **streamsize** n, unsigned char \*\_\_put=0)\ **strstreambuf** (const char \*\_\_get, **streamsize** n)\ **strstreambuf** (const signed char \*\_\_get, **streamsize** n)\ **strstreambuf** (const unsigned char \*\_\_get, **streamsize** n)\ virtual **~strstreambuf** ()\ void **freeze** (bool=true)\ char \* **str** ()\ int **pcount** () const\ **locale** **pubimbue** (const **locale** &\_\_loc)\ *Entry point for* **imbue()***.* **locale** **getloc** () const\ *Locale access.* **streamsize** **in\_avail** ()\ *Looking ahead into the stream.* **int\_type** **snextc** ()\ *Getting the next character.* **int\_type** **sbumpc** ()\ *Getting the next character.* **int\_type** **sgetc** ()\ *Getting the next character.* **streamsize** **sgetn** (**char\_type** \*s, **streamsize** n)\ *Entry point for xsgetn.* **int\_type** **sputbackc** (**char\_type** c)\ *Pushing characters back into the input stream.* **int\_type** **sungetc** ()\ *Moving backwards in the input stream.* **int\_type** **sputc** (**char\_type** c)\ *Entry point for all single-character output functions.* **streamsize** **sputn** (const **char\_type** \*s, **streamsize** n)\ *Entry point for all single-character output functions.* **streambuf\_type** \* **pubsetbuf** (**char\_type** \*s, **streamsize** n)\ *Entry points for derived buffer functions.* **pos\_type** **pubseekoff** (**off\_type** \_\_off, **ios\_base::seekdir** \_\_way, **ios\_base::openmode** \_\_mode=**ios\_base::in**\|**ios\_base::out**)\ *Entry points for derived buffer functions.* **pos\_type** **pubseekpos** (**pos\_type** sp, **ios\_base::openmode** \_\_mode=**ios\_base::in**\|**ios\_base::out**)\ *Entry points for derived buffer functions.* int **pubsync** ()\ *Entry points for derived buffer functions.* ### Protected Member Functions virtual **int\_type** **overflow** (**int\_type** c=Traits::eof())\ virtual **int\_type** **pbackfail** (**int\_type** c=Traits::eof())\ virtual **int\_type** **underflow** ()\ *Fetches more data from the controlled sequence.* virtual **Base** \* **setbuf** (char \*\_\_buf, **streamsize** n)\ virtual **pos\_type** **seekoff** (**off\_type** \_\_off, **ios\_base::seekdir** \_\_dir, **ios\_base::openmode** \_\_mode=**ios\_base::in**\|**ios\_base::out**)\ virtual **pos\_type** **seekpos** (**pos\_type** position, **ios\_base::openmode** \_\_mode=**ios\_base::in**\|**ios\_base::out**)\ void **M\_pback\_create** ()\ void **M\_pback\_destroy** () throw ()\ void **M\_in\_cur\_move** (**off\_type** n)\ void **M\_out\_cur\_move** (**off\_type** n)\ **off\_type** **M\_out\_buf\_size** ()\ void **gbump** (int n)\ *Moving the read position.* void **setg** (**char\_type** \*\_\_gbeg, **char\_type** \*\_\_gnext, **char\_type** \*\_\_gend)\ *Setting the three read area pointers.* void **pbump** (int n)\ *Moving the write position.* void **setp** (**char\_type** \*\_\_pbeg, **char\_type** \*\_\_pend)\ *Setting the three write area pointers.* virtual void **imbue** (const **locale** &)\ *Changes translations.* virtual **basic\_streambuf**\< **char\_type**, **Traits** \> \* **setbuf** (**char\_type** \*, **streamsize**)\ *Maniuplates the buffer.* virtual **pos\_type** **seekoff** (**off\_type**, **ios\_base::seekdir**, **ios\_base::openmode**=**ios\_base::in**\|**ios\_base::out**)\ *Alters the stream positions.* virtual **pos\_type** **seekpos** (**pos\_type**, **ios\_base::openmode**=**ios\_base::in**\|**ios\_base::out**)\ *Alters the stream positions.* virtual int **sync** ()\ *Synchronizes the buffer arrays with the controlled sequences.* virtual **streamsize** **showmanyc** ()\ *Investigating the data available.* virtual **streamsize** **xsgetn** (**char\_type** \*s, **streamsize** n)\ *Multiple character extraction.* virtual **int\_type** **uflow** ()\ *Fetches more data from the controlled sequence.* virtual **int\_type** **pbackfail** (**int\_type**=traits\_type::eof())\ *Tries to back up the input sequence.* virtual **streamsize** **xsputn** (const **char\_type** \*s, **streamsize** n)\ *Multiple character insertion.* virtual **int\_type** **overflow** (**int\_type**=traits\_type::eof())\ *Consumes data from the buffer; writes to the controlled sequence.* **char\_type** \* **eback** () const\ *Access to the get area.* **char\_type** \* **gptr** () const\ *Access to the get area.* **char\_type** \* **egptr** () const\ *Access to the get area.* **char\_type** \* **pbase** () const\ *Access to the put area.* **char\_type** \* **pptr** () const\ *Access to the put area.* **char\_type** \* **epptr** () const\ *Access to the put area.* ### Protected Attributes **char\_type** \* **M\_buf**\ size\_t **M\_buf\_size**\ size\_t **M\_buf\_size\_opt**\ bool **M\_buf\_unified**\ **ios\_base::openmode** **M\_mode**\ **locale** **M\_buf\_locale**\ bool **M\_buf\_locale\_init**\ **fpos**\< **state\_type** \> **M\_pos**\ **char\_type** \* **M\_in\_beg**\ **char\_type** \* **M\_in\_cur**\ **char\_type** \* **M\_in\_end**\ **char\_type** \* **M\_out\_beg**\ **char\_type** \* **M\_out\_cur**\ **char\_type** \* **M\_out\_end**\ ### Private Member Functions char \* **M\_alloc** (size\_t)\ void **M\_free** (char \*)\ void **M\_setup** (char \*\_\_get, char \*\_\_put, **streamsize** n)\ ### Private Attributes bool **M\_dynamic**: 1\ bool **M\_frozen**: 1\ bool **M\_constant**: 1\ ### Friends class **basic\_ios\< char\_type, traits\_type \>**\ class **basic\_istream\< char\_type, traits\_type \>**\ class **basic\_ostream\< char\_type, traits\_type \>**\ class **istreambuf\_iterator\< char\_type, traits\_type \>**\ class **ostreambuf\_iterator\< char\_type, traits\_type \>**\ ## Detailed Description Definition at line 62 of file strstream. ## Member Typedef Documentation ### template\ typedef CharT std::basic\_streambuf\< CharT, Traits \>::char\_type` [inherited]` These are standard types. They permit a standardized way of referring to names of (or names dependant on) the template parameters, which are specific to the implementation. Reimplemented in **\_\_gnu\_cxx::stdio\_filebuf\< CharT, Traits \>**, **std::basic\_filebuf\< CharT, Traits \>**, **std::basic\_stringbuf\< CharT, Traits, Alloc \>**, and **std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>**. Definition at line 134 of file streambuf. ### template\ typedef Traits std::basic\_streambuf\< CharT, Traits \>::traits\_type` [inherited]` These are standard types. They permit a standardized way of referring to names of (or names dependant on) the template parameters, which are specific to the implementation. Reimplemented in **\_\_gnu\_cxx::stdio\_filebuf\< CharT, Traits \>**, **std::basic\_filebuf\< CharT, Traits \>**, **std::basic\_stringbuf\< CharT, Traits, Alloc \>**, and **std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>**. Definition at line 135 of file streambuf. ### template\ typedef traits\_type::int\_type std::basic\_streambuf\< CharT, Traits \>::int\_type` [inherited]` These are standard types. They permit a standardized way of referring to names of (or names dependant on) the template parameters, which are specific to the implementation. Reimplemented in **\_\_gnu\_cxx::stdio\_filebuf\< CharT, Traits \>**, **std::basic\_filebuf\< CharT, Traits \>**, **std::basic\_stringbuf\< CharT, Traits, Alloc \>**, and **std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>**. Definition at line 136 of file streambuf. ### template\ typedef traits\_type::pos\_type std::basic\_streambuf\< CharT, Traits \>::pos\_type` [inherited]` These are standard types. They permit a standardized way of referring to names of (or names dependant on) the template parameters, which are specific to the implementation. Reimplemented in **\_\_gnu\_cxx::stdio\_filebuf\< CharT, Traits \>**, **std::basic\_filebuf\< CharT, Traits \>**, **std::basic\_stringbuf\< CharT, Traits, Alloc \>**, and **std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>**. Definition at line 137 of file streambuf. ### template\ typedef traits\_type::off\_type std::basic\_streambuf\< CharT, Traits \>::off\_type` [inherited]` These are standard types. They permit a standardized way of referring to names of (or names dependant on) the template parameters, which are specific to the implementation. Reimplemented in **\_\_gnu\_cxx::stdio\_filebuf\< CharT, Traits \>**, **std::basic\_filebuf\< CharT, Traits \>**, **std::basic\_stringbuf\< CharT, Traits, Alloc \>**, and **std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>**. Definition at line 138 of file streambuf. ## Member Function Documentation ### strstreambuf::int\_type std::strstreambuf::underflow ()` [protected, virtual]` Fetches more data from the controlled sequence. **Returns:** The first character from the *pending sequence*. Informally, this function is called when the input buffer is exhausted (or does not exist, as buffering need not actually be done). If a buffer exists, it is 'refilled'. In either case, the next available character is returned, or `traits::eof()` to indicate a null pending sequence. For a formal definiton of the pending sequence, see a good text such as Langer & Kreft, or \[27.5.2.4.3\]/7-14. A functioning input streambuf can be created by overriding only this function (no buffer area will be used). For an example, see http://gcc.gnu.org/onlinedocs/libstdc++/27\_io/howto.html#6 **Note:** Base class version does nothing, returns eof(). Reimplemented from **std::basic\_streambuf\< CharT, Traits \>**. Definition at line 213 of file strstream.cc. References std::basic\_streambuf\< CharT, Traits \>::eback(), std::basic\_streambuf\< CharT, Traits \>::egptr(), std::basic\_streambuf\< CharT, Traits \>::gptr(), std::basic\_streambuf\< CharT, Traits \>::pptr(), and std::basic\_streambuf\< CharT, Traits \>::setg(). ### template\ locale std::basic\_streambuf\< CharT, Traits \>::pubimbue (const locale & \_\_loc)` [inline, inherited]` Entry point for **imbue()**. **Parameters:** *loc* The new locale. **Returns:** The previous locale. Calls the derived imbue(loc). Definition at line 378 of file streambuf. ### template\ locale std::basic\_streambuf\< CharT, Traits \>::getloc () const` [inline, inherited]` Locale access. **Returns:** The current locale in effect. If pubimbue(loc) has been called, then the most recent `loc` is returned. Otherwise the global locale in effect at the time of construction is returned. Definition at line 395 of file streambuf. Referenced by std::basic\_filebuf\< CharT, Traits \>::M\_convert\_to\_external(), and std::basic\_filebuf\< CharT, Traits \>::showmanyc(). ### template\ streambuf\_type\* std::basic\_streambuf\< CharT, Traits \>::pubsetbuf (char\_type \* s, streamsize n)` [inline, inherited]` Entry points for derived buffer functions. The public versions of `pubfoo` dispatch to the protected derived `foo` member functions, passing the arguments (if any) and returning the result unchanged. Definition at line 408 of file streambuf. ### template\ pos\_type std::basic\_streambuf\< CharT, Traits \>::pubseekoff (off\_type \_\_off, ios\_base::seekdir \_\_way, ios\_base::openmode \_\_mode = ios\_base::in` | `ios\_base::out)` [inline, inherited]` Entry points for derived buffer functions. The public versions of `pubfoo` dispatch to the protected derived `foo` member functions, passing the arguments (if any) and returning the result unchanged. Definition at line 412 of file streambuf. ### template\ pos\_type std::basic\_streambuf\< CharT, Traits \>::pubseekpos (pos\_type sp, ios\_base::openmode \_\_mode = ios\_base::in` | `ios\_base::out)` [inline, inherited]` Entry points for derived buffer functions. The public versions of `pubfoo` dispatch to the protected derived `foo` member functions, passing the arguments (if any) and returning the result unchanged. Definition at line 417 of file streambuf. ### template\ int std::basic\_streambuf\< CharT, Traits \>::pubsync ()` [inline, inherited]` Entry points for derived buffer functions. The public versions of `pubfoo` dispatch to the protected derived `foo` member functions, passing the arguments (if any) and returning the result unchanged. Definition at line 422 of file streambuf. ### template\ streamsize std::basic\_streambuf\< CharT, Traits \>::in\_avail ()` [inline, inherited]` Looking ahead into the stream. **Returns:** The number of characters available. If a read position is available, returns the number of characters available for reading before the buffer must be refilled. Otherwise returns the derived **showmanyc().** **Definition at line 435 of file streambuf.** ### template\ int\_type std::basic\_streambuf\< CharT, Traits \>::snextc ()` [inline, inherited]` **Getting the next character.** **Returns:** **The next character, or eof.** **Calls sbumpc(), and if that function returns** `traits::eof()`**, so does this function. Otherwise, sgetc().** **Definition at line 462 of file streambuf.** **Referenced by std::copy\_streambufs().** ### template\ basic\_streambuf\< CharT, Traits \>::int\_type std::basic\_streambuf\< CharT, Traits \>::sbumpc ()` [inherited]` **Getting the next character.** **Returns:** **The next character, or eof.** **If the input read position is available, returns that character and increments the read pointer, otherwise calls and returns uflow().** **Definition at line 49 of file streambuf.tcc.** **References std::basic\_streambuf\< CharT, Traits \>::gptr(), and std::basic\_streambuf\< CharT, Traits \>::uflow().** **Referenced by std::operator\>\>().** ### template\ int\_type std::basic\_streambuf\< CharT, Traits \>::sgetc ()` [inline, inherited]` **Getting the next character.** **Returns:** **The next character, or eof.** **If the input read position is available, returns that character, otherwise calls and returns underflow(). Does not move the read position after fetching the character.** **Definition at line 489 of file streambuf.** **Referenced by std::copy\_streambufs().** ### template\ streamsize std::basic\_streambuf\< CharT, Traits \>::sgetn (char\_type \* s, streamsize n)` [inline, inherited]` **Entry point for xsgetn.** **Parameters:** *s* **A buffer area.** \ *n* **A count.** **Returns xsgetn(s,n). The effect is to fill** *s***\[0\] through** *s***\[n-1\] with characters from the input sequence, if possible.** **Definition at line 508 of file streambuf.** ### template\ basic\_streambuf\< CharT, Traits \>::int\_type std::basic\_streambuf\< CharT, Traits \>::sputbackc (char\_type c)` [inherited]` **Pushing characters back into the input stream.** **Parameters:** *c* **The character to push back.** **Returns:** **The previous character, if possible.** **Similar to sungetc(), but** *c* **is pushed onto the stream instead of 'the previous character'. If successful, the next character fetched from the input stream will be** *c***.** **Definition at line 66 of file streambuf.tcc.** **References std::basic\_streambuf\< CharT, Traits \>::pbackfail().** **Referenced by std::operator\>\>().** ### template\ basic\_streambuf\< CharT, Traits \>::int\_type std::basic\_streambuf\< CharT, Traits \>::sungetc ()` [inherited]` **Moving backwards in the input stream.** **Returns:** **The previous character, if possible.** **If a putback position is available, this function decrements the input pointer and returns that character. Otherwise, calls and returns pbackfail(). The effect is to 'unget' the last character 'gotten'.** **Definition at line 83 of file streambuf.tcc.** **References std::basic\_streambuf\< CharT, Traits \>::pbackfail().** ### template\ basic\_streambuf\< CharT, Traits \>::int\_type std::basic\_streambuf\< CharT, Traits \>::sputc (char\_type c)` [inherited]` **Entry point for all single-character output functions.** **Parameters:** *c* **A character to output.** **Returns:** *c***, if possible.** **One of two public output functions.** **If a write position is available for the output sequence (i.e., the buffer is not full), stores** *c* **in that position, increments the position, and returns** `traits::to_int_type(c)`**. If a write position is not available, returns** `overflow(c)`**.** **Definition at line 104 of file streambuf.tcc.** **References std::basic\_streambuf\< CharT, Traits \>::overflow().** **Referenced by std::copy\_streambufs(), and std::basic\_stringbuf\< CharT, Traits, Alloc \>::overflow().** ### template\ streamsize std::basic\_streambuf\< CharT, Traits \>::sputn (const char\_type \* s, streamsize n)` [inline, inherited]` **Entry point for all single-character output functions.** **Parameters:** *s* **A buffer read area.** \ *n* **A count.** **One of two public output functions.** **Returns xsputn(s,n). The effect is to write** *s***\[0\] through** *s***\[n-1\] to the output sequence, if possible.** **Definition at line 564 of file streambuf.** **Referenced by std::copy\_streambufs().** ### template\ char\_type\* std::basic\_streambuf\< CharT, Traits \>::eback () const` [inline, protected, inherited]` **Access to the get area.** **These functions are only available to other protected functions, including derived classes.** - • **eback() returns the beginning pointer for the input sequence** - • **gptr() returns the next pointer for the input sequence** - • **egptr() returns the end pointer for the input sequence** **Definition at line 599 of file streambuf.** **Referenced by overflow(), pbackfail(), seekoff(), std::basic\_stringbuf\< CharT, Traits, Alloc \>::seekpos(), str(), underflow(), and ~strstreambuf().** ### template\ char\_type\* std::basic\_streambuf\< CharT, Traits \>::gptr () const` [inline, protected, inherited]` **Access to the get area.** **These functions are only available to other protected functions, including derived classes.** - • **eback() returns the beginning pointer for the input sequence** - • **gptr() returns the next pointer for the input sequence** - • **egptr() returns the end pointer for the input sequence** **Definition at line 602 of file streambuf.** **Referenced by std::basic\_streambuf\< char, Traits \>::in\_avail(), overflow(), pbackfail(), std::basic\_streambuf\< CharT, Traits \>::sbumpc(), seekoff(), std::basic\_stringbuf\< CharT, Traits, Alloc \>::seekoff(), underflow(), and std::basic\_stringbuf\< CharT, Traits, Alloc \>::underflow().** ### template\ char\_type\* std::basic\_streambuf\< CharT, Traits \>::egptr () const` [inline, protected, inherited]` **Access to the get area.** **These functions are only available to other protected functions, including derived classes.** - • **eback() returns the beginning pointer for the input sequence** - • **gptr() returns the next pointer for the input sequence** - • **egptr() returns the end pointer for the input sequence** **Definition at line 605 of file streambuf.** **Referenced by std::basic\_streambuf\< char, Traits \>::in\_avail(), seekoff(), std::basic\_stringbuf\< CharT, Traits, Alloc \>::seekoff(), std::basic\_stringbuf\< CharT, Traits, Alloc \>::seekpos(), and underflow().** ### template\ void std::basic\_streambuf\< CharT, Traits \>::gbump (int n)` [inline, protected, inherited]` **Moving the read position.** **Parameters:** *n* **The delta by which to move.** **This just advances the read position without returning any data.** **Definition at line 615 of file streambuf.** **Referenced by pbackfail().** ### template\ void std::basic\_streambuf\< CharT, Traits \>::setg (char\_type \* \_\_gbeg, char\_type \* \_\_gnext, char\_type \* \_\_gend)` [inline, protected, inherited]` **Setting the three read area pointers.** **Parameters:** *gbeg* **A pointer.** \ *gnext* **A pointer.** \ *gend* **A pointer.** **Postcondition:** *gbeg* **== eback(),** *gnext* **== gptr(), and** *gend* **== egptr()** **Definition at line 626 of file streambuf.** **Referenced by std::basic\_filebuf\< CharT, Traits \>::M\_destroy\_internal\_buffer(), std::basic\_streambuf\< char, Traits \>::M\_pback\_create(), std::basic\_streambuf\< char, Traits \>::M\_pback\_destroy(), std::basic\_stringbuf\< CharT, Traits, Alloc \>::M\_really\_sync(), std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>::M\_set\_determinate(), std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>::M\_set\_indeterminate(), M\_setup(), overflow(), seekoff(), strstreambuf(), and underflow().** ### template\ char\_type\* std::basic\_streambuf\< CharT, Traits \>::pbase () const` [inline, protected, inherited]` **Access to the put area.** **These functions are only available to other protected functions, including derived classes.** - • **pbase() returns the beginning pointer for the output sequence** - • **pptr() returns the next pointer for the output sequence** - • **epptr() returns the end pointer for the output sequence** **Definition at line 648 of file streambuf.** **Referenced by overflow(), pcount(), seekoff(), and std::basic\_stringbuf\< CharT, Traits, Alloc \>::seekpos().** ### template\ char\_type\* std::basic\_streambuf\< CharT, Traits \>::pptr () const` [inline, protected, inherited]` **Access to the put area.** **These functions are only available to other protected functions, including derived classes.** - • **pbase() returns the beginning pointer for the output sequence** - • **pptr() returns the next pointer for the output sequence** - • **epptr() returns the end pointer for the output sequence** **Definition at line 651 of file streambuf.** **Referenced by overflow(), pcount(), seekoff(), std::basic\_stringbuf\< CharT, Traits, Alloc \>::seekoff(), and underflow().** ### template\ char\_type\* std::basic\_streambuf\< CharT, Traits \>::epptr () const` [inline, protected, inherited]` **Access to the put area.** **These functions are only available to other protected functions, including derived classes.** - • **pbase() returns the beginning pointer for the output sequence** - • **pptr() returns the next pointer for the output sequence** - • **epptr() returns the end pointer for the output sequence** **Definition at line 654 of file streambuf.** **Referenced by overflow(), seekoff(), and std::basic\_stringbuf\< CharT, Traits, Alloc \>::seekoff().** ### template\ void std::basic\_streambuf\< CharT, Traits \>::pbump (int n)` [inline, protected, inherited]` **Moving the write position.** **Parameters:** *n* **The delta by which to move.** **This just advances the write position without returning any data.** **Definition at line 664 of file streambuf.** **Referenced by overflow(), and seekoff().** ### template\ void std::basic\_streambuf\< CharT, Traits \>::setp (char\_type \* \_\_pbeg, char\_type \* \_\_pend)` [inline, protected, inherited]` **Setting the three write area pointers.** **Parameters:** *pbeg* **A pointer.** \ *pend* **A pointer.** **Postcondition:** *pbeg* **== pbase(),** *pbeg* **== pptr(), and** *pend* **== epptr()** **Definition at line 674 of file streambuf.** **Referenced by std::basic\_filebuf\< CharT, Traits \>::M\_destroy\_internal\_buffer(), std::basic\_stringbuf\< CharT, Traits, Alloc \>::M\_really\_sync(), std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>::M\_set\_determinate(), std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>::M\_set\_indeterminate(), M\_setup(), overflow(), seekoff(), and strstreambuf().** ### template\ virtual void std::basic\_streambuf\< CharT, Traits \>::imbue (const locale &)` [inline, protected, virtual, inherited]` **Changes translations.** **Parameters:** *loc* **A new locale.** **Translations done during I/O which depend on the current locale are changed by this call. The standard adds, 'Between invocations of this function a class derived from streambuf can safely cache results of calls to locale functions and to members of facets so obtained.'** **Note:** **Base class version does nothing.** **Reimplemented in std::basic\_filebuf\< CharT, Traits \>, and std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>.** **Definition at line 697 of file streambuf.** **Referenced by std::basic\_streambuf\< char, Traits \>::pubimbue().** ### template\ virtual basic\_streambuf\\* std::basic\_streambuf\< CharT, Traits \>::setbuf (char\_type \*, streamsize)` [inline, protected, virtual, inherited]` **Maniuplates the buffer.** **Each derived class provides its own appropriate behavior. See the next-to-last paragraph of http://gcc.gnu.org/onlinedocs/libstdc++/27\_io/howto.html#2 for more on this function.** **Note:** **Base class version does nothing, returns** `this`**.** **Reimplemented in std::basic\_filebuf\< CharT, Traits \>, std::basic\_stringbuf\< CharT, Traits, Alloc \>, and std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>.** **Definition at line 712 of file streambuf.** **Referenced by std::basic\_streambuf\< char, Traits \>::pubsetbuf().** ### template\ virtual pos\_type std::basic\_streambuf\< CharT, Traits \>::seekoff (off\_type, ios\_base::seekdir, ios\_base::openmode = ios\_base::in` | `ios\_base::out)` [inline, protected, virtual, inherited]` **Alters the stream positions.** **Each derived class provides its own appropriate behavior.** **Note:** **Base class version does nothing, returns a** `pos_type` **that represents an invalid stream position.** **Reimplemented in std::basic\_filebuf\< CharT, Traits \>, std::basic\_stringbuf\< CharT, Traits, Alloc \>, and std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>.** **Definition at line 723 of file streambuf.** **Referenced by std::basic\_streambuf\< char, Traits \>::pubseekoff().** ### template\ virtual pos\_type std::basic\_streambuf\< CharT, Traits \>::seekpos (pos\_type, ios\_base::openmode = ios\_base::in` | `ios\_base::out)` [inline, protected, virtual, inherited]` **Alters the stream positions.** **Each derived class provides its own appropriate behavior.** **Note:** **Base class version does nothing, returns a** `pos_type` **that represents an invalid stream position.** **Reimplemented in std::basic\_filebuf\< CharT, Traits \>, std::basic\_stringbuf\< CharT, Traits, Alloc \>, and std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>.** **Definition at line 735 of file streambuf.** **Referenced by std::basic\_streambuf\< char, Traits \>::pubseekpos().** ### template\ virtual int std::basic\_streambuf\< CharT, Traits \>::sync (void)` [inline, protected, virtual, inherited]` **Synchronizes the buffer arrays with the controlled sequences.** **Returns:** **-1 on failure.** **Each derived class provides its own appropriate behavior, including the definition of 'failure'.** **Note:** **Base class version does nothing, returns zero.** **Reimplemented in std::basic\_filebuf\< CharT, Traits \>, and std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>.** **Definition at line 748 of file streambuf.** **Referenced by std::basic\_streambuf\< char, Traits \>::pubsync().** ### template\ virtual streamsize std::basic\_streambuf\< CharT, Traits \>::showmanyc ()` [inline, protected, virtual, inherited]` **Investigating the data available.** **Returns:** **An estimate of the number of characters available in the input sequence, or -1.** **Note:** **Base class version does nothing, returns zero.** **The standard adds that 'the intention is not only that the calls \[to underflow or uflow\] will not return** `eof()` **but that they will return 'immediately'.** **The standard adds that 'the morphemes of** `showmanyc` **are 'es-how-many-see', not 'show-manic'.** **Reimplemented in std::basic\_filebuf\< CharT, Traits \>, and std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>.** **Definition at line 770 of file streambuf.** **Referenced by std::basic\_streambuf\< char, Traits \>::in\_avail().** ### template\ streamsize std::basic\_streambuf\< CharT, Traits \>::xsgetn (char\_type \* s, streamsize n)` [protected, virtual, inherited]` **Multiple character extraction.** **Parameters:** *s* **A buffer area.** \ *n* **Maximum number of characters to assign.** **Returns:** **The number of characters assigned.** **Fills** *s***\[0\] through** *s***\[n-1\] with characters from the input sequence, as if by sbumpc(). Stops when either** *n* **characters have been copied, or when** `traits::eof()` **would be copied.** **It is expected that derived classes provide a more efficient implementation by overriding this definition.** **Reimplemented in std::basic\_filebuf\< CharT, Traits \>, and std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>.** **Definition at line 121 of file streambuf.tcc.** **References std::copy(), std::min(), and std::basic\_streambuf\< CharT, Traits \>::uflow().** **Referenced by std::basic\_streambuf\< char, Traits \>::sgetn().** ### template\ virtual int\_type std::basic\_streambuf\< CharT, Traits \>::uflow ()` [inline, protected, virtual, inherited]` **Fetches more data from the controlled sequence.** **Returns:** **The first character from the** *pending sequence***.** **Informally, this function does the same thing as underflow(), and in fact is required to call that function. It also returns the new character, like underflow() does. However, this function also moves the read position forward by one.** **Reimplemented in std::basic\_filebuf\< CharT, Traits \>, and std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>.** **Definition at line 821 of file streambuf.** **Referenced by std::basic\_streambuf\< CharT, Traits \>::sbumpc(), and std::basic\_streambuf\< CharT, Traits \>::xsgetn().** ### template\ virtual int\_type std::basic\_streambuf\< CharT, Traits \>::pbackfail (int\_type = `traits_type::eof()`)` [inline, protected, virtual, inherited]` **Tries to back up the input sequence.** **Parameters:** *c* **The character to be inserted back into the sequence.** **Returns:** **eof() on failure, 'some other value' on success** **Postcondition:** **The constraints of gptr(), eback(), and pptr() are the same as for underflow().** **Note:** **Base class version does nothing, returns eof().** **Reimplemented in std::basic\_filebuf\< CharT, Traits \>, std::basic\_stringbuf\< CharT, Traits, Alloc \>, and std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>.** **Definition at line 847 of file streambuf.** **Referenced by std::basic\_streambuf\< CharT, Traits \>::sputbackc(), and std::basic\_streambuf\< CharT, Traits \>::sungetc().** ### template\ streamsize std::basic\_streambuf\< CharT, Traits \>::xsputn (const char\_type \* s, streamsize n)` [protected, virtual, inherited]` **Multiple character insertion.** **Parameters:** *s* **A buffer area.** \ *n* **Maximum number of characters to write.** **Returns:** **The number of characters written.** **Writes** *s***\[0\] through** *s***\[n-1\] to the output sequence, as if by sputc(). Stops when either** *n* **characters have been copied, or when sputc() would return** `traits::eof()`**.** **It is expected that derived classes provide a more efficient implementation by overriding this definition.** **Reimplemented in std::basic\_filebuf\< CharT, Traits \>, and std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>.** **Definition at line 160 of file streambuf.tcc.** **References std::copy(), std::min(), and std::basic\_streambuf\< CharT, Traits \>::overflow().** **Referenced by std::basic\_streambuf\< char, Traits \>::sputn().** ### template\ virtual int\_type std::basic\_streambuf\< CharT, Traits \>::overflow (int\_type = `traits_type::eof()`)` [inline, protected, virtual, inherited]` **Consumes data from the buffer; writes to the controlled sequence.** **Parameters:** *c* **An additional character to consume.** **Returns:** **eof() to indicate failure, something else (usually** *c***, or not\_eof())** **Informally, this function is called when the output buffer is full (or does not exist, as buffering need not actually be done). If a buffer exists, it is 'consumed', with 'some effect' on the controlled sequence. (Typically, the buffer is written out to the sequence verbatim.) In either case, the character** *c* **is also written out, if** *c* **is not** `eof()`**.** **For a formal definiton of this function, see a good text such as Langer & Kreft, or \[27.5.2.4.5\]/3-7.** **A functioning output streambuf can be created by overriding only this function (no buffer area will be used).** **Note:** **Base class version does nothing, returns eof().** **Reimplemented in std::basic\_filebuf\< CharT, Traits \>, std::basic\_stringbuf\< CharT, Traits, Alloc \>, and std::basic\_filebuf\< CharT, \_\_gnu\_cxx::enc\_char\_traits\< CharT \> \>.** **Definition at line 890 of file streambuf.** **Referenced by std::basic\_streambuf\< CharT, Traits \>::sputc(), and std::basic\_streambuf\< CharT, Traits \>::xsputn().** ## Author **Generated automatically by Doxygen for libstdc++-v3 Source from the source code.**