Updated documentation (Issue 248)
parent
15ec4ef713
commit
fcdc845bba
|
|
@ -1658,7 +1658,14 @@ public:
|
||||||
|
|
||||||
//! \brief Discard skipMax bytes from the output buffer
|
//! \brief Discard skipMax bytes from the output buffer
|
||||||
//! \param skipMax the number of bytes to discard
|
//! \param skipMax the number of bytes to discard
|
||||||
//! \details Skip always returns skipMax.
|
//! \details Skip() discards bytes from the output buffer, which is the AttachedTransformation(), if present.
|
||||||
|
//! The function always returns skipMax.
|
||||||
|
//! \details If you want to skip bytes from a Source, then perform the following.
|
||||||
|
//! <pre>StringSource ss(str, false, new Redirector(TheBitBucket()));
|
||||||
|
//! ss.Pump(10); // Skip 10 bytes from Source
|
||||||
|
//! ss.Detach(new FilterChain(...));
|
||||||
|
//! ss.PumpAll();
|
||||||
|
//! </pre>
|
||||||
virtual lword Skip(lword skipMax=LWORD_MAX);
|
virtual lword Skip(lword skipMax=LWORD_MAX);
|
||||||
|
|
||||||
//! copy copyMax bytes of the buffered output to target as input
|
//! copy copyMax bytes of the buffered output to target as input
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue