サンプルコードで学ぶASP

(PWS4 IIS4 IIS5)
ReadText — 文字列型の Stream オブジェクトから、指定した文字数のデータを読み取ります。

構文

Stream.ReadText NumChars

パラメータ

Stream

Streamオブジェクトを指定します。

NumChars

省略可能です。ファイルから読み取る文字数を指定する長整数型 (Long) の値、または StreamReadEnum 値を指定します。既定値は adReadAll です。

戻り値

ReadText メソッドは、Stream オブジェクトから指定文字数、行全体、またはストリーム全体を読み取り、読み取った文字列を返します。

説明

NumChar の指定文字数が Stream の残り文字数を超える場合は、残っている文字のみが返されます。読み取った文字列は、NumChar で指定された長さに一致するように補充されることはありません。読み取る文字が残っていない場合は、Null 値を持つバリアント型の値が返されます。ReadText は、逆方向の読み取りには使用できません。

注意 ReadText メソッドは、文字列型ストリーム (Type が adTypeText) で使用します。バイナリ型のストリーム (Type が adTypeBinary) には、Read メソッドを使用してください。

(PWS4 IIS4 IIS5)
Read — バイナリ型の Stream オブジェクトから、指定したバイト数のデータを読み取ります。

構文

Stream.Read NumBytes

パラメータ

Stream

Streamオブジェクトを指定します。

NumBytes

省略可能です。ファイルから読み取るバイト数を指定する長整数型 (Long) の値、または StreamReadEnum 値を指定します。既定値は adReadAll です。

戻り値

Read メソッドは、Stream オブジェクトから指定バイト数またはストリーム全体を読み取り、読み取ったデータをバリアント型 (Variant) の値として返します。

説明

NumBytes の指定バイト数が Stream の残りバイト数を超える場合は、残っているバイトのみが返されます。読み取ったデータは、NumBytes で指定された長さに一致するように補充されることはありません。読み取るバイトが残っていない場合は、Null 値を持つバリアント型の値が返されます。Read メソッドは、逆方向の読み取りには使用できません。

注意 NumBytes は、常にバイト数を表すものです。文字列型の Stream オブジェクト (Type が adTypeText) には、ReadText を使用してください。

(PWS4 IIS4 IIS5)
Open — バイナリ データまたはテキスト データのストリームを操作する Stream オブジェクトを開きます。

構文

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

パラメータ

Stream

Streamオブジェクトを指定します。

Stream

省略可能です。Stream のデータ ソースを示すバリアント型 (Variant) の値を指定します。Source には、電子メールシステムやファイル システムのような、ツリー構造の既存ノードを指す絶対 URL の文字列を指定することもできます。URL を指定する場合は、”URL=scheme://server/folder” のように、URL キーワードを使用する必要があります。また、Source に既に開いている Record オブジェクトへの参照を指定し、その Record に関連付けられた既定のストリームを開くこともできます。Source を指定しない場合、Stream のインスタンスが生成されて開かれ、既定では、基になるソースは関連付けられません。

Mode

省略可能です。結果の Stream のアクセス モード (読み取り/書き込み、読み取り専用など) を ConnectModeEnum 値で指定します。既定値は adModeUnknown です。アクセス モードの詳細については、Mode プロパティを参照してください。Mode を指定しない場合は、ソース オブジェクトのアクセス モードが継承されます。たとえば、ソース Record が読み取り専用モードで開かれている場合、既定では、その Stream も読み取り専用モードで開かれます。

OpenOptions

省略可能です。StreamOpenOptionsEnum 値を指定します。既定値は adOpenStreamUnspecified です。

UserName

省略可能です。Stream オブジェクトへのアクセス権が設定されている場合、アクセス権を持つユーザー ID を含む、文字列型 (String) の値を指定します。

Password

省略可能です。Stream オブジェクトにアクセスするためのパスワードを含む文字列型 (String) の値を指定します。

説明

Source パラメータに Record オブジェクトを指定する場合、その Record オブジェクトへのアクセスは既に有効になっているので、UserID パラメータおよび Password パラメータは使用されません。同様に、Record オブジェクトの Mode が Stream オブジェクトに転送されます。Source を指定しない場合、開かれた Stream にはデータが含まれず、Size はゼロ (0) になります。この Stream を閉じたときに、そこに書き込まれたデータが失われないようにするには、その Stream を、CopyTo メソッドまたは SaveToFile メソッドを使って保存するか、メモリの別の場所に保存します。

OpenOptions に adOpenStreamFromRecord を指定すると、Source パラメータの内容が、既に開かれている Record オブジェクトとして識別されます。既定動作では、Source は、ファイルなどのツリー構造のノードを直接指定する URL として処理されます。そのため、このノードに関連付けられた既定ストリームが開かれます。

Stream が開かれていないときは、その Stream のすべての読み取り専用プロパティを取得することができます。Stream が非同期で開かれている場合、後に続くすべての操作 (State プロパティおよびその他の読み取り専用プロパティのチェックを除く) は、Open 操作が終了するまでブロックされます。

ここで説明したオプション以外にも、Source を指定しないことにより、基になるソースとの関連付けを行わずにメモリ内で Stream オブジェクトのインスタンスを作成する方法もあります。Write メソッドまたは WriteText メソッドを使用してバイナリデータまたはテキスト データを Stream に書き込んだり、LoadFromFile メソッドを使用してファイルからデータを読み込むことにより、ストリームに動的にデータを追加することができます。

(PWS4 IIS4 IIS5)
LoadFromFile — 既存ファイルの内容を Stream に読み込みます。

構文

Stream.LoadFromFile FileName

パラメータ

Stream

Streamオブジェクトを指定します。

FileName

Stream に読み込むファイルの名前を含む、文字列型 (String) の値を指定します。FileName には、ローカルまたは UNC 形式の有効なパスとファイル名を指定できます。指定したファイルが存在しない場合は、実行時エラーが発生します。

説明

このメソッドで、ファイルの内容を Stream オブジェクトに読み込むことができます。このメソッドで、ファイルの内容をサーバーにアップロードすることができます。

LoadFromFile を呼び出す前に、Stream オブジェクトが開かれている必要があります。このメソッドでは、Stream オブジェクトのバインディングは変更されず、その Stream を開いた URL または Record で指定されたオブジェクトにバインドされたままです。

LoadFromFile メソッドでは、Stream オブジェクトの現在の内容を、ファイルから読み込んだデータで上書きします。Stream の既存のバイトはすべて、ファイルの内容で上書きされます。LoadFromFile メソッドで作成された EOS の後に残っている既存のバイトは、すべて削除されます。

LoadFromFile メソッドを呼び出した後、現在の位置は Stream の先頭になり、Position が 0 に設定されます。

(PWS4 IIS4 IIS5)
Flush — ADO バッファに保持されている Stream の内容を、その Stream が関連付けられた、基になるオブジェクトに反映します。

構文

Stream.Flush

パラメータ

Stream

Streamオブジェクトを指定します。

戻り値

値を返しません。

説明

このメソッドを使用すると、基になるオブジェクト (Stream オブジェクトのソースの URL で表されるノードやファイルなど) に、ストリームバッファの内容を送ることができます。Stream の内容に加えたすべての変更が確実に書き込まれるようにするには、このメソッドを呼び出す必要があります。ただし、ADO では、バックグラウンドで可能な限り継続してバッファのフラッシュが行われるので、通常は Flush メソッドを呼び出す必要はありません。Stream の内容の更新は自動的に行われます。Flush メソッドが呼ばれるまでキャッシュされるわけではありません。

Close メソッドを使って Stream を閉じると、Stream の内容が自動的にフラッシュされるので、Close を呼び出す前に明示的に Flush メソッドを呼び出す必要はありません。

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

構文

Stream.CopyTo DestStream, NumChars

パラメータ

Stream

Streamオブジェクトを指定します。

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 オブジェクトの場合、コピー先の Stream の Charset プロパティの設定値を変更すると、文字セットを別の文字セットに変換することができます。また、文字列型の Stream オブジェクトをバイナリ型の Stream オブジェクトにコピーすることもできますが、バイナリ型の Stream オブジェクトを文字列型の Stream オブジェクトにコピーすることはできません。

(PWS4 IIS4 IIS5)
Close — 開いているオブジェクトおよびそれに従属するすべてのオブジェクトを閉じます。

構文

Stream.Close

パラメータ

Stream

Streamオブジェクトを指定します。

戻り値

値を返しません。

説明

Close メソッドを使って、Connection オブジェクト、Record オブジェクト、Recordset オブジェクト、または Stream オブジェクトを閉じ、関連するすべてのシステムリソースを解放します。オブジェクトを閉じてもメモリからは削除されず、プロパティ設定を変更してもう一度開くことができます。メモリからオブジェクトを完全に削除するには、オブジェクトを閉じて、オブジェクト変数を Nothing (Visual Basic の場合) に設定します。

Close メソッドを使って Recordset オブジェクト、Record オブジェクト、または Stream オブジェクトを閉じると、関連するデータと、そのデータに対するこのオブジェクトからの排他アクセスがすべて解放されます。その後で Open メソッドを呼び出して、同じ属性または更新された属性を持つオブジェクトを再度開くことができます。

Recordset オブジェクトが閉じているときに、開いているカーソルを必要とするメソッドを呼び出すと、エラーが発生します。

即時更新モードで編集しているときに Close メソッドを呼び出すと、エラーが発生します。この場合は、先に Update メソッドまたは CancelUpdate メソッドを呼び出してください。バッチ更新モードの実行中に Recordset オブジェクトを閉じると、最後に UpdateBatch メソッドを実行した後に行われた変更がすべて失われます。

Clone メソッドを使って開いている Recordset オブジェクトのコピーを作成した場合、元のオブジェクトまたはクローンを閉じてもほかのコピーには影響しません。

(PWS4 IIS4 IIS5)
Cancel — 非同期メソッド呼び出しのうち、保留中のものの実行をキャンセルします。

構文

Stream.Cancel

パラメータ

Stream

Streamオブジェクトを指定します。

戻り値

値を返しません。

説明

Cancel メソッドを使って、非同期メソッド (Open) の呼び出しの実行を中止します。

(PWS4 IIS4 IIS5)
Type — Stream (バイナリまたはテキスト) 内のデータの種類を示します。

構文

Stream.Type

パラメータ

Stream

Streamオブジェクトを指定します。

設定値と戻り値

Stream オブジェクトに格納されたデータの種類を表す StreamTypeEnum の値を設定します。また、値の取得も可能です。既定値は adTypeText です。バイナリ データの場合は、Type を指定しないと書き込めません。

説明

Type プロパティは、現在の位置が Stream の先頭 (Position が 0) の場合のみ、読み取り/書き込み可能であり、その他の位置の場合は、読み取り専用になります。

その Stream の読み取りと書き込みに使用するメソッドは、Type プロパティによって決まります。テキスト Streams では、ReadText と WriteText を使用します。バイナリ型の Streams では、Read と Write を使用します。

(PWS4 IIS4 IIS5)
State — 対象になるすべてのオブジェクトについて、そのオブジェクトが開いているか、または閉じているかを示します。
非同期メソッドを実行している対象の全オブジェクトについて、そのオブジェクトが現在、接続、実行、取得のどの状態であるかを示します。

構造

Stream.State

パラメータ

Stream

Streamオブジェクトを指定します。

戻り値

ObjectStateEnum 値となる長整数型 (Long) の値を返します。既定値は adStateClosed です。

説明

State プロパティを使えば、オブジェクトの現在の状態をいつでも調べることができます。

オブジェクトの State プロパティの値は組み合わせることができます。たとえば、ステートメントが実行中のときは、プロパティの値は adStateOpen と adStateExecuting の組み合わせになります。

State プロパティは読み取り専用です。