[#bsl-basic_stringbuf-xsgetn-0f]
= xref:bsl.adoc[bsl]::xref:bsl/basic_stringbuf.adoc[basic_stringbuf]::xsgetn
:relfileprefix: ../../
:mrdocs:

Multiple character extraction.

== Synopsis

Declared in `<bslstl_stringbuf.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
virtual
streamsize
xsgetn(
    char_type* __s,
    streamsize __n);
----

== Description

Fills ___s[0]_ through ___s[]_ 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.

== Return Value

The number of characters assigned.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *__s*
| A buffer area.
| *__n*
| Maximum number of characters to assign.
|===


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