Read characters from the input sequence.

Synopsis

Declared in <bslstl_stringbuf.h>

virtual
std::streamsize
xsgetn(
    char_type* result,
    std::streamsize numCharacters);

Description

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.

Return Value

number of characters loaded into result

Parameters

Name

Description

result

destination array for characters read from the buffer

numCharacters

maximum number of characters to read

Created with MrDocs