Stream オブジェクト (バージョン 2.5、2.6)
Dim stream As ADODB.Stream

Stream オブジェクトは、URL または Record オブジェクトから取得したか、いずれの場所からも取得していないデータのストリームを表します。

Stream.Cancel メソッド (バージョン 2.5、2.6)

record.Cancel
 

Cancel メソッドは Stream オブジェクトの非同期操作をキャンセルします。

説明

Cancel メソッドは、Open メソッドによって呼び出された Record オブジェクトの非同期操作をキャンセルします。

 
関連項目

Stream.Open メソッド

 
Stream.CharSet プロパティ (バージョン 2.5、2.6)

stream.CharSet = characterset
 

CharSet プロパティは、テキストストリームのコンテンツの変換先となる文字セットを示します。

データタイプ

String

 
説明

CharSet プロパティは、Stream オブジェクトの Position プロパティが 0 に設定されている場合のみ、有効な文字セットに設定できます。システムで有効な文字セットは、HKEY_CLASSES_ROOT\MIME\Database\CharSet サブキーに定義されています。

CharSet プロパティの初期設定値は "unicode" です。文字セットが変換される場合、そのデータはストリームからの読み取り中に変換され、アプリケーションに渡されます。データを記述するときは、データは変換されてからデータソースに保存されます。

このプロパティは、テキストストリームのみに有効です。このテキストストリームは、Type プロパティ値に adTypeText を持つ Stream オブジェクトです。

 
関連項目

Stream.Type プロパティ

 
Stream.Close メソッド (バージョン 2.5、2.6)

record.Close
 

Close メソッドは開いている Stream オブジェクトを閉じます。

説明

Close メソッドは、開いている Stream オブジェクト上のみで呼び出すことができます。Close メソッドを呼び出した後に、Open メソッドを再度呼び出して Stream オブジェクトをもう一度開くことができます。Close メソッドを呼び出すと、Stream オブジェクトに割り当てられたリソースが解放されます。

 
Stream.CopyTo メソッド (バージョン 2.5、2.6)

stream.CopyTo DestStream, NumChars
 

CopyTo メソッドは、1 つのストリームから別のストリームにデータをコピーします。

パラメータ
DestStream (Stream オブジェクト)

開いている有効な Stream オブジェクトに設定する必要があります。それ以外の場合はランタイムエラーが発生します。

NumChars (整数)

オプションです。コピー元からコピー先 Stream オブジェクトにコピーする文字数を指定します。初期設定値は -1 で、すべての残りのデータをコピーする必要があることを示します。

 
説明

CopyTo メソッドは、現在のストリームポインタの位置 (Stream.Position プロパティによって示されます) より、コピー元の Stream オブジェクトからデータをコピーします。コピーされる文字数は、NumChars パラメータで示される数になります。または、NumChars パラメータがコピー元の残りの文字数より大きい場合か、NumChars パラメータ値が -1 である場合は、コピー元の残りの数になります。

コピー先の Stream オブジェクトのストリームポインタの位置は、Stream オブジェクトで利用できる次のバイトに自動的に設定されます。CopyTo メソッドは、コピー後にコピー先の Stream オブジェクトから余分なデータを削除しません。この操作を行うには、SetEOS メソッドを呼び出します。

データはテキストの Stream オブジェクトからバイナリの Stream オブジェクトにコピーできますが、バイナリの Stream オブジェクトからテキストの Stream オブジェクトにコピーすることはできません。

 
関連項目

Stream.Position プロパティ、Stream.SetEOS メソッド

 
Stream.EOS プロパティ (バージョン 2.5、2.6)

Boolean = stream.EOS
 

EOS プロパティは、ストリームポインタが現在ストリームの最後にあることを示します。

データタイプ

Boolean

 
説明

ストリームポインタがストリーム内の最後の情報の後に直接あり、End-Of-Stream ポインタを指し示している場合、EOS プロパティは True になります。

 
Stream.Flush メソッド (バージョン 2.5、2.6)

stream.Flush
 

Flush メソッドは、Stream オブジェクトに対して行われたすべての変更が、Stream オブジェクトが表すリソースに存続されるようにします。

説明

Flush メソッドは、Stream オブジェクトの未処理の変更を、Stream オブジェクトが表すリソースに存続させます。Microsoft では、ADO がこのメソッドを可能な限りバックグラウンドで内部的に呼び出すため、これはほとんど必要ないと説明しています。さらに、Stream オブジェクトを閉じる場合、ストリームは最初にデータソースにフラッシュされます。

 
Stream.LineSeparator プロパティ (バージョン 2.5、2.6)

stream.LineSeparator = lineseparator
 

LineSeparator は、テキストストリームで行末を示すために使用される文字を示します。

データタイプ

LineSeparatorEnum

 
説明

LineSeparator プロパティの初期設定値は adCRLF です。これはキャリッジリターンおよびラインフィードの両方を示します。

このプロパティは、テキストストリームのみに有効です。このテキストストリームは、Type プロパティ値に adTypeText を持つ Stream オブジェクトです。

 
関連項目

LineSeparatorEnum 列挙、Stream.SkipLine メソッド

 
Stream.LoadFromFile メソッド (バージョン 2.5、2.6)

stream.LoadFromFile FileName
 

LoadFromFile メソッドは、ファイルのコンテンツを既に開いている Stream オブジェクトに読み込みます。

パラメータ
FileName (文字列)

現在開いている Stream オブジェクトに読み込む有効なファイルの名前を含んでいる必要があります。このパラメータによって指定されたファイルが見つからない場合は、ランタイムエラーが発生します。

 
説明

LoadFromFile メソッドは、既に開いている Stream オブジェクトに対して動作し、このオブジェクトのコンテンツを、LoadFromFile パラメータ FileName 内で指定されたファイルのコンテンツと置き換えます。既に存在しているすべてのデータは上書きされ、余分なデータは切り捨てられます。ただし、Stream オブジェクトは元々開かれたリソースとの関係を失いません。

LoadFromFile メソッドを使用して、クライアントからサーバーにファイルをアップロードできます。

 
Stream.Mode プロパティ (バージョン 2.5、2.6)

stream.Mode = ConnectModeEnum
 

Mode プロパティは、Stream オブジェクト内でデータを変更する権限を示します。

データタイプ

ConnectModeEnum

 
説明

基になるソースと関連付けられた、Stream オブジェクトの Mode プロパティの初期設定値は adModeRead です。メモリでインスタンス化される Stream オブジェクトには、Mode プロパティの初期設定値 adModeUnknown が含まれます。

Mode プロパティは読み取りと書き込みが可能です。Stream オブジェクトは閉じられていますが、いったん開くと読み取り専用になります。

Stream オブジェクトで Mode プロパティが指定されない場合、Record オブジェクトなど、オブジェクトを開くときに使用されたソースから継承されます。

 
関連項目

ConnectModeEnum 列挙、Stream.Open メソッド

 
Stream.Open メソッド (バージョン 2.5、2.6)

stream.Open Source, Mode, OpenOptions, UserName, Password
 

Open メソッドは、URL または開いている Record オブジェクトから Stream オブジェクトを開きます。または、ソースを使用せず、メモリから Stream オブジェクトを開きます。

パラメータ
Source (Variant)

オプションです。開くリソースのソースを示します。これは URL または開いている Record オブジェクトとすることができます。このパラメータを省略すると、メモリ内の Stream オブジェクトのみを開くように ADO に指示します。

Mode (ConnectModeEnum)

オプションです。Stream オブジェクトを開くアクセス権限を示します。初期設定値は adModeUnknown です。Stream オブジェクトが Record オブジェクトを使用して開かれた場合、Mode の値はそのオブジェクトから受け取られ、このパラメータは無視されます。

OpenOptions (StreamOpenOptions)

オプションです。Stream オブジェクトを非同期に開くか、Record オブジェクトから開かれているかを示す、StreamOpenOptions 列挙値とすることができますが、初期設定値は adOpenStreamUnspecified です。

UserName (文字列)

オプションです。必要に応じて、ソースパラメータによって示されたリソースにアクセスするために使用されるユーザー名を示します。Record オブジェクトを使用して Stream オブジェクトを開いた場合、この値は無視されます。これは、既にアクセスがリソースに対して利用できるようになっているためです。

Password (文字列)

オプションです。必要に応じて、UserName パラメータを確認するパスワードを示します。Record オブジェクトを使用して Stream オブジェクトを開いた場合、この値は無視されます。これは、既にアクセスがリソースに対して利用できるようになっているためです。

 
説明

Stream オブジェクトの Open メソッドは、URL リソースまたは既に開かれている Record オブジェクトを使用して実行できます。または、まったくソースを使用せずに実行できますが、この場合は、Stream オブジェクトがメモリで開かれていることを示します。この最後の方法を使用する場合、他の方法と同じように Stream オブジェクトの読み取りと書き込みができますが、データを持続および取得するには、SaveToFile または LoadFromFile メソッドを使用する必要があります。

既に開かれた Record オブジェクトから Stream オブジェクトを開くときは、Mode 値が Record オブジェクトから受け取られ、UserName および Password プロパティ (指定した場合) は無視されます。これは、Record オブジェクトが開かれている場合、既にアクセスが付与されている必要があるためです。Record オブジェクトから Stream オブジェクトを開く場合は、adOpenStreamFromRecord 列挙値を OpenOptions パラメータとして指定します。ADO は Record オブジェクトのデフォルトのストリームを使用して、Stream オブジェクトへの挿入を行います。

URL を使用して Stream オブジェクトを開く場合は、URL のキーワード (URL=scheme://server/folder) を使用する必要があります。

 
関連項目

ConnectModeEnum 列挙、Stream.LoadFromFile メソッド、Stream.Mode プロパティ、Stream.SaveToFile メソッド、StreamOpenOptionsEnum 列挙

 
Stream.Position プロパティ (バージョン 2.5、2.6)

stream.Position = number
 

Position プロパティは、Stream オブジェクト内のストリームポインタの位置を示します。

データタイプ

Long

 
説明

Position プロパティは任意の正の数値または 0 に設定できます。現在の Stream オブジェクトのサイズよりも大きい値に設定することもできます。そのときに、書き込み許可のあるストリームでは、自動的に Null 値を追加することで、Stream オブジェクトのサイズを増やすことができます。お勧めはしませんが、読み取り専用ストリームにも同じことができます。ただし、サイズは変更されません。

Position プロパティは、ストリームの最初のバイトからストリームポインタが置かれているバイト数を表します。文字セットに、各文字の複数のバイトが含まれている場合、実際の文字の位置を取得するための位置にその値を掛ける必要があります。たとえば、Unicode を使用する場合、0 は最初の文字を表し、2 は 2 番目の文字を表します。

 
Stream.Read メソッド (バージョン 2.5、2.6)

bytes = stream.Read (NumBytes)
 

Read メソッドは、バイナリストリームからバイト数を読み取ります。

パラメータ
NumBytes (Long または StreamReadEnum)

オプションです。バイナリストリームから読み取るバイト数を示します。初期設定値は adReadAll で、ストリームの残りのすべてのバイト数を返します。

 
戻り値

バリアント (配列)

 
説明

Read メソッドは、バイナリストリームを読み取るために使用され (Stream.Type プロパティは adTypeBinary と等しい)、ReadText メソッドはテキストストリームを読み取るために使用されます (Stream.Type プロパティは adTypeText と等しい)。

戻り値はバイトのバリアント配列となり、要求されたバイト数と等しくなります。残りのバイト数が要求されたバイト数より少ない場合は、ストリームの残りのバイト数と等しくなります。返すデータがない場合は、Null バリアント値が返されます。

 
関連項目

Stream.ReadText メソッド、Stream.Type プロパティ、StreamReadEnum 列挙

 
Stream.ReadText メソッド (バージョン 2.5、2.6)

string = stream.ReadText (NumChars)
 

ReadText メソッドは、バイナリストリームから文字数を読み取ります。

パラメータ
NumChars (Long または StreamReadEnum)

オプションです。テキストストリームから読み取る文字数を示します。初期設定値は adReadAll で、ストリームの残りのすべての文字数を返します。adReadLine 列挙値を使用すると、次の行のデータを返すように指定できます。

 
戻り値

文字列

 
説明

ReadText メソッドはテキストストリームを読み取り (Stream.Type プロパティは adTypeText と等しい)、Read メソッドはバイナリストリームを読み取るために使用されます (Stream.Type プロパティは adTypeBinary と等しい)。

戻り値は値の文字列となり、要求された文字数と等しくなります。残りの文字数が要求された文字数より少ない場合は、ストリームの残りの文字数と等しくなります。返すデータがない場合は、Null バリアント値が返されます。

 
関連項目

Stream.Read メソッド、Stream.Type プロパティ、StreamReadEnum 列挙

 
Stream.SaveToFile メソッド (バージョン 2.5、2.6)

stream.SaveToFile (FileName, SaveOptions)
 

SaveToFile メソッドは、バイナリストリームのデータをローカルファイルに存続させます。

パラメータ
FileName (文字列)

現在の Stream オブジェクトのコンテンツを持続させる場所を示します。

SaveOptions (SaveOptionsEnum)

ファイルが存在しない場合にそのファイルを作成するかどうか、既存のファイルを上書きするかどうか、またはファイルが既に存在する場合にエラーを発生させるかどうかを指定します。

 
説明

SaveToFile メソッドは、SaveOptions パラメータで adSaveCreateOverwrite 列挙値が使用されている場合に、既存のファイルを完全に上書きします。

このメソッドを使用しても、Stream オブジェクトのコンテンツ、または Stream オブジェクトを開くときに使用した元のリソースとの関連は変更されません。Stream オブジェクトとの唯一の違いは、Position プロパティがストリーム (0) の先頭に設定されることです。

 
関連項目

SaveOptionsEnum 列挙、Stream.Position プロパティ

 
Stream.SetEOS メソッド (バージョン 2.5、2.6)

stream.SetEOS
 

SetEOS メソッドは、指定された Stream オブジェクト内の EOS を変更し、新しい EOS ポインタ以降のデータを切り捨てます。

説明

SetEOS メソッドは、Write、WriteText、および CopyTo メソッドを使用中に、Stream オブジェクトの長さを短くできます。これらのメソッドを使用してストリームを切り捨てることはできません。

 
関連項目

Stream.CopyTo メソッド、Stream.Write メソッド、Stream.WriteText メソッド

 
Stream.Size プロパティ (バージョン 2.5、2.6)

size = stream.Size
 

Size プロパティは、Stream オブジェクトのバイト数を表します。

データタイプ

Long

 
説明

Stream オブジェクトのサイズはリソースのみによって制限されるので、Long 値が含むことができる最大値を超えた場合、Long 値は Stream のサイズを正しく含むことができない可能性があります。

ストリームのサイズが不明な場合は、-1 が返されます。

 
Stream.SkipLine メソッド (バージョン 2.5、2.6)

stream.SkipLine
 

SkipLine メソッドは、テキストストリームを読み取るときに行全体をスキップします。

説明

SkipLine メソッドはテキストストリームの行全体をスキップします (Stream.Type は adTypeText と等しい)。これは、行区切り文字または EOS ポインタが次に出現する位置を検索することで行われます。行区切り文字は LineSeparator プロパティによって示され、このプロパティはデフォルトで adCRLF に設定されます。

 
関連項目

LineSeparatorEnum 列挙、Stream.LineSeparator プロパティ、Stream.Type プロパティ

 
Stream.State プロパティ (バージョン 2.5、2.6)

state = record.State
 

State プロパティは、Stream オブジェクトの現在の状態を示します。

データタイプ

Long (ObjectStateEnum)

 
説明

State プロパティは読み取り専用です。ObjectStateEnum 列挙値として評価できる Long 値を返します。Stream オブジェクトの初期設定値は closed です。

State プロパティは、Stream オブジェクトが非同期に操作を実行中に複数の値 (adStateOpen および adStateExecuting) を返すことができます。

 
関連項目

ObjectStateEnum 列挙

 
Stream.Type プロパティ (バージョン 2.5、2.6)

streamtype = stream.Type
 

Type プロパティは、Stream オブジェクトのデータを分析する方法を示します。

データタイプ

StreamTypeEnum 列挙

 
説明

Stream オブジェクトの初期設定値は adTypeText ですが、バイナリデータが新しい Stream オブジェクトに書き込まれた場合、Type プロパティは自動的に adTypeBinary に変更されます。

Type プロパティは、ストリームポインタが 0 (Position プロパティが 0 に等しい) であるときは読み取りと書き込みが可能で、他の位置にあるときは読み取り専用になります。

Type プロパティが adTypeText に設定された場合は、データの操作と取得には ReadText および WriteText メソッドを使用する必要があります。Type プロパティが adTypeBinary に設定された場合は、データの操作と取得には Read および Write メソッドを使用する必要があります。

 
関連項目

Stream.Read メソッド、Stream.ReadText メソッド、Stream.Write メソッド、Stream.WriteText メソッド、StreamTypeEnum 列挙

 
Stream.Write メソッド (バージョン 2.5、2.6)

stream.Write Buffer
 

Write メソッドは、バイナリストリームにバイト数を書き込みます。

パラメータ
Buffer (Variant)

現在のバイナリストリームに書き込む Byte 値の配列を含みます。

 
説明

Position プロパティは、指定されたバイトを Stream オブジェクトに書き込んだ後、書き込んだ最後のバイトに続く次のバイトに設定されます。書き込まれたデータの最後の後に既存のデータがある場合、そのデータは切り捨てられません。このデータを切り捨てる場合は、SetEOS メソッドを呼び出します。

書き込まれたデータが Stream オブジェクトの長さを超える場合、新しいデータが Stream オブジェクトに追加され、ストリームの長さが増えます。また、EOS ポインタがストリームの新しい最後に移動されます。

Write メソッドは、バイナリストリームに書き込むために使用され (Stream.Type プロパティは adTypeBinary と等しい)、WriteText メソッドはテキストストリームに書き込むために使用されます (Stream.Type プロパティは adTypeText と等しい)。

 
関連項目

Stream.EOS プロパティ、Stream.SetEOS メソッド、Stream.Type プロパティ、Stream.WriteText メソッド、StreamWriteEnum 列挙

 
Stream.WriteText メソッド (バージョン 2.5、2.6)

stream.WriteText Data, Options
 

WriteText メソッドは、バイナリストリームにバイト数を書き込みます。

パラメータ
Data (文字列)

Stream オブジェクトに書き込む文字列データを表します。

Options (StreamWriteEnum)

オプションです。Stream オブジェクトにデータのみが書き込まれるのか、データと行区切り文字が書き込まれるのかを示します。行区切り文字は LineSeparator プロパティによって示されます。デフォルトでは、行区切り文字は書き込まれません。

 
説明

Position プロパティは、指定された文字列を Stream オブジェクトに書き込んだ後、書き込んだ最後の文字列に続く次の文字列に設定されます。書き込まれたデータの最後の後に既存のデータがある場合、そのデータは切り捨てられません。このデータを切り捨てる場合は、SetEOS メソッドを呼び出します。

書き込まれたデータが Stream オブジェクトの長さを超える場合、新しいデータが Stream オブジェクトに追加され、ストリームの長さが増えます。また、EOS ポインタがストリームの新しい最後に移動されます。

WriteText メソッドは、テキストストリームに書き込むために使用され (Stream.Type プロパティは adTypeText と等しい)、Write メソッドはバイナリストリームに書き込むために使用されます (Stream.Type プロパティは adTypeBinary と等しい)。

 
関連項目

Stream.EOS プロパティ、Stream.SetEOS メソッド、Stream.Type プロパティ、Stream.WriteText メソッド、StreamWriteEnum 列挙