[#bsl-basic_istringstream-ignore-0f]
= xref:bsl.adoc[bsl]::xref:bsl/basic_istringstream.adoc[basic&lowbar;istringstream]::ignore
:relfileprefix: ../../
:mrdocs:

Discarding characters

== Synopsis

Declared in `&lt;bslstl&lowbar;istringstream&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
&lowbar;&lowbar;istream&lowbar;type&
ignore(
    streamsize &lowbar;&lowbar;n,
    int&lowbar;type &lowbar;&lowbar;delim);
----

== Description

Extracts characters and throws them away until one of the following happens&colon;

* if _&lowbar;&lowbar;n_ `!&equals;` `std&colon;&colon;numeric&lowbar;limits&lt;int&gt;&colon;&colon;max(),` _&lowbar;&lowbar;n_ characters are extracted
* the input sequence reaches end&hyphen;of&hyphen;file
* the next character equals _&lowbar;&lowbar;delim_ (in this case, the character is extracted)&semi; note that this condition will never occur if _&lowbar;&lowbar;delim_ equals `traits&colon;&colon;eof()&period;`

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

== Return Value

&ast;this

== Parameters

[cols="1,4"]
|===
| Name| Description
| *&lowbar;&lowbar;n*
| Number of characters to discard&period;
| *&lowbar;&lowbar;delim*
| A &quot;stop&quot; character&period;
|===


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