CopyTo メソッド

Stream オブジェクトから、指定した文字数またはバイト数 (Type によって決まる) のデータを別の Stream オブジェクトにコピーします。

構文

Stream.CopyTo DestStream, NumChars

パラメータ

DestStream
開いている Stream オブジェクトへの参照を含むオブジェクト変数の値を指定します。DestStream で指定した Stream に、現在の Stream がコピーされます。コピー先の Stream は既に開かれている必要があります。コピー先の Stream が開かれていない場合は、実行時エラーが発生します。

注意   DestStream パラメータに、Stream オブジェクトのプロキシを指定することはできません。これは、クライアントにリモート接続できない Stream オブジェクト上で、プライベート インターフェイスにアクセスを行うためです。

NumChars
省略可能です。ソース Stream の現在の位置からコピー先の Stream にコピーするバイト数または文字数を指定する整数型 (Integer) の値を指定します。既定値は -1 で、現在の位置から EOS までのすべての文字またはバイトをコピーするように指定します。

解説

このメソッドは、Position プロパティで指定された現在の位置から指定数の文字またはバイトをコピーします。指定した数が、EOS までの利用可能バイト数を超える場合は、現在の位置から EOS までの文字またはバイトのみがコピーされます。NumChars の値が -1 の場合、または省略されている場合は、現在の位置から始まるすべての文字またはバイトがコピーされます。

コピー先のストリームに既存の文字またはバイトが存在する場合、コピーの終了ポイント以降の内容はすべてそのまま残り、削除されません。Position は、コピーされた最後のバイトの次のバイトになります。これらのバイトを削除する場合は、SetEOS を呼び出してください。

CopyTo メソッドは、同じ種類の Stream 間でデータをコピーする場合、つまり、コピー元とコピー先の Type プロパティの設定値がいずれも adTypeText であるか、またはいずれも adTypeBinary である場合に使用します。文字列型の Stream オブジェクトの場合、コピー先の StreamCharset プロパティの設定値を変更すると、文字セットを別の文字セットに変換することができます。また、文字列型の Stream オブジェクトをバイナリ型の Stream オブジェクトにコピーすることもできますが、バイナリ型の Stream オブジェクトを文字列型の Stream オブジェクトにコピーすることはできません。

関連項目

適用: Stream オブジェクト

表示: