[#bsl-basic_istringstream-ignore-0f]
= xref:bsl.adoc[bsl]::xref:bsl/basic_istringstream.adoc[basic_istringstream]::ignore
:relfileprefix: ../../
:mrdocs:

Discarding characters

== Synopsis

Declared in `<bslstl_istringstream.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
__istream_type&
ignore(
    streamsize __n,
    int_type __delim);
----

== Description

Extracts characters and throws them away until one of the following happens:

* if ___n_ `!=` `std::numeric_limits<int>::max(),` ___n_ characters are extracted
* the input sequence reaches end‐of‐file
* the next character equals ___delim_ (in this case, the character is extracted); note that this condition will never occur if ___delim_ equals `traits::eof().`

NB: Provide three overloads, instead of the single function (with defaults) mandated by the Standard: this leads to a better performing implementation, while still conforming to the Standard.

== Return Value

*this

== Parameters

[cols="1,4"]
|===
| Name| Description
| *__n*
| Number of characters to discard.
| *__delim*
| A "stop" character.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#