[#BloombergLP-bdlsb-FixedMemInput-sgetn]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlsb.adoc[bdlsb]::xref:BloombergLP/bdlsb/FixedMemInput.adoc[FixedMemInput]::sgetn
:relfileprefix: ../../../
:mrdocs:

Read characters from this buffer into the specified destination.

== Synopsis

Declared in `<bdlsb_fixedmeminput.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::streamsize
sgetn(
    xref:BloombergLP/bdlsb/FixedMemInput/char_type.adoc[char_type]* destination,
    std::streamsize length);
----

== Description

Read the specified `length` characters to the specified `destination`. Return the number of characters successfully read from this buffer, which is either equal to the `length` parameter or equal to the distance from the current read position to the end of the input buffer, whichever is smaller, and move the read cursor position by this amount. The behavior is undefined unless '0 <= length'.

== Return Value

number of characters successfully read

== Parameters

[cols="1,4"]
|===
| Name| Description
| *destination*
| buffer that receives the characters read
| *length*
| maximum number of characters to read
|===


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