basic_streambuf::_Xsgetn_s

Protected, virtual function to extract elements from the input stream.

virtual streamsize _Xsgetn_s(
    char_type *_Ptr,
    size_t _Ptr_size,
    streamsize _Count
);

Parameters

  • _Ptr
    The buffer to contain the extracted characters.

  • _Ptr_size
    The size of _Ptr.

  • _Count
    The number of elements to extract.

Return Value

The number of elements extracted.

Remarks

The protected virtual member function extracts up to _Count elements from the input stream, as if by repeated calls to sbumpc, and stores them in the array beginning at _Ptr. It returns the number of elements actually extracted.

Requirements

Header: <streambuf>

Namespace: std

See Also

Reference

basic_streambuf Class

iostream Programming

iostreams Conventions

Safe Libraries: Standard C++ Library

Other Resources

basic_streambuf Members