Name
Stream.CopyTo Method — (Versions 2.5, 2.6)
Synopsis
stream.CopyTo DestStream, NumChars
The CopyTo method copies data from one stream to another.
Arguments
-
DestStream(Stream Object) Must be set to a valid open Stream object, otherwise a runtime error occurs.
-
NumChars(Integer) Optional. Specifies the number of characters to copy from the source to the destination Stream object. The default value is -1, which indicates that all remaining data should be copied.
Description
The CopyTo method copies data from the source Stream object starting
at the current stream pointer position (indicated by the
Stream.Position property). The number of characters copied is either
the number indicated by the NumChars
argument or the rest of the source stream if the
NumChars argument is greater than the
number of remaining characters in the source stream or the
NumChars argument value is -1.
The stream pointer position of the destination Stream object is automatically set to the next byte available in the Stream object. The CopyTo method will not remove excess data from the destination Stream object past the copy. To do this, call the SetEOS method.
You can copy data from a textual Stream to a binary Stream object, but not from a binary Stream to a textual Stream object.
See Also
Stream.Position Property, Stream.SetEOS Method
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access