Position

(PWS4 IIS4 IIS5)
Position — Stream オブジェクト内の現在の位置を示します。

構文

Stream.Position

パラメータ

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

設定値と戻り値

ストリームの先頭から現在の位置までのオフセットを示す長整数型 (Long) の値を、バイト単位で設定します。また、値の取得も可能です。既定値は、ストリームの最初のバイトを表す 0 です。

説明

カレントの位置は、ストリームの末尾を超えて移動できます。ストリームの末尾を超えてカレントの位置を指定すると、Stream オブジェクトの Size もそれに応じて拡張されます。こうして追加される新しいバイトは、すべて Null になります。

注意 Position の単位は常にバイトです。マルチバイト文字セットを使うテキストストリームでは、すべての文字が同じバイト数である文字セットを使う場合、Position は文字数 -1 に 1 文字のバイト数を乗じた値です。たとえば、2 バイト文字セットの場合、最初の文字は、位置 0、2 番目の文字は、位置 2、3 番目の文字は、位置 4 のように続きます。

Stream の現在の位置は負の数では変更できません。Position には正の数しか使えません。

読み取り専用 Stream オブジェクトの場合、Position を Stream の Size より大きく設定するとエラーになります。これによって Stream のサイズや Stream の内容が変更されることはありません。ただし、Position の値が意味のない値になるので、このような操作はしないでください。

関連ページ