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

`xsgetn` overloads

== Synopses

Declared in `<bslstl_stringbuf.h>`

Multiple character extraction.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
virtual
streamsize
xref:bsl/basic_stringbuf/xsgetn-0f.adoc[xsgetn](
    char_type* __s,
    streamsize __n);
----

[.small]#xref:bsl/basic_stringbuf/xsgetn-0f.adoc[_» more..._]#

Read up to the specified `numCharacters` from this `stringbuf` object and store them in the specified `result` array. Return the number of characters loaded into `result`. Note that if fewer than `numCharacters` characters are available in the buffer, all available characters are loaded into `result`. The behavior is undefined unless `result` refers to a contiguous sequence of at least `numCharacters` characters.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
virtual
std::streamsize
xref:bsl/basic_stringbuf/xsgetn-01.adoc[xsgetn](
    xref:bsl/basic_stringbuf/char_type.adoc[char_type]* result,
    std::streamsize numCharacters);
----

[.small]#xref:bsl/basic_stringbuf/xsgetn-01.adoc[_» more..._]#

== 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]#