FileStream.Seek メソッド

.NET Framework クラス ライブラリ リファレンス

FileStream.Seek メソッド

ストリームの現在位置を特定の値に設定します。

名前空間: System.IO
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Overrides Function
 Seek ( _
    offset As Long, _
    origin As SeekOrigin _
) As Long

Visual Basic (使用法)

Dim instance As FileStream
Dim offset As Long
Dim origin As SeekOrigin
Dim returnValue As Long

returnValue = instance.Seek(offset, origin)

C#

public override long Seek (
    long offset,
    SeekOrigin origin
)

C++

public:
virtual long long Seek (
    long long offset, 
    SeekOrigin origin
) override

J#

public long Seek (
    long offset, 
    SeekOrigin origin
)

JScript

public override function Seek (
    offset : long, 
    origin : SeekOrigin
) : long

パラメータ

offset

シークの開始位置 origin に対して相対的なポイント。

origin

SeekOrigin 型の値を使用して、origin の参照ポイントとして先頭、末尾、または現在位置を指定します。

戻り値
ストリームの新しい位置。

例外

例外の種類	条件
IOException	I/O エラーが発生しました。
NotSupportedException	ストリームがシークをサポートしていません。たとえば、FileStream がパイプまたはコンソール出力から構築されました。
ArgumentException	ストリームの開始前にシークしようとしました。
ObjectDisposedException	ストリームが閉じられた後でメソッドが呼び出されました。

解説

このメソッドは、Seek をオーバーライドします。

メモ
現在のインスタンスがシークをサポートしているかどうかを判断するには、CanSeek プロパティを使用します。詳細については、CanSeek のトピックを参照してください。

ストリーム長を超えた位置へのシークがサポートされています。ファイルの長さを超えてシークすると、ファイル サイズが大きくなります。Microsoft Windows NT 以降では、ファイルの末尾に追加されたデータは、すべて 0 に設定されます。Windows 98 以前では、ファイルの末尾に追加されたデータは 0 に設定されません。つまり、以前に削除されたデータがストリームに対して可視になります。

その他の一般的な I/O タスクまたは関連する I/O タスクの例を次の表に示します。

実行するタスク	参考例があるトピック
テキスト ファイルを作成する。	方法 : ファイルにテキストを書き込む
テキスト ファイルに書き込む。	方法 : ファイルにテキストを書き込む
テキスト ファイルから読み取る。	方法 : ファイルからテキストを読み取る
テキストをファイルに追加する。	方法 : ログ ファイルを開いて情報を追加する File.AppendText FileInfo.AppendText
ファイルの名前を変更、またはファイルを移動する。	File.Move FileInfo.MoveTo
ファイルをコピーする。	File.Copy FileInfo.CopyTo
ディレクトリのサイズを取得する。	FileInfo.Length
ファイルの属性を取得する。	File.GetAttributes
ファイルの属性を設定する。	File.SetAttributes
サブディレクトリを作成する。	CreateSubdirectory
バイナリ ファイルから読み取る。	方法 : 新しく作成されたデータ ファイルに対して読み書きする
バイナリ ファイルに書き込む。	方法 : 新しく作成されたデータ ファイルに対して読み書きする
ディレクトリ内のファイルを参照する。	Name
ディレクトリ内のファイルをサイズ順に並べ替える。	GetFileSystemInfos

使用例

ファイルにデータをバイト単位で書き込み、さらにデータが正常に書き込まれたことを確認する例を次に示します。

Visual Basic

Imports Microsoft.VisualBasic
Imports System
Imports System.IO
Imports System.Text

Class FStream

    Shared Sub Main()

        Const fileName As String
 = "Test#@@#.dat"

        ' Create random data to write to the file.
        Dim dataArray(100000) As Byte
        Dim randomGenerator As New
 Random()
        randomGenerator.NextBytes(dataArray)

        Dim fileStream As FileStream = _
            new FileStream(fileName, FileMode.Create)
        Try

            ' Write the data to the file, byte by byte.
            For i As Integer
 = 0 To dataArray.Length - 1
                fileStream.WriteByte(dataArray(i))
            Next i

            ' Set the stream position to the beginning of the stream.
            fileStream.Seek(0, SeekOrigin.Begin)

            ' Read and verify the data.
            For i As Integer
 = 0 To _
                CType(fileStream.Length, Integer) - 1

                If dataArray(i) <> fileStream.ReadByte()
 Then
                    Console.WriteLine("Error writing data.")
                    Return
                End If
            Next i
            Console.WriteLine("The data was written to {0} "
 & _
                "and verified.", fileStream.Name)
        Finally
            fileStream.Close()
        End Try
    
    End Sub
End Class

C#

using System;
using System.IO;

class FStream
{
    static void Main()
    {
        const string fileName = "Test#@@#.dat";

        // Create random data to write to the file.
        byte[] dataArray = new byte[100000];
        new Random().NextBytes(dataArray);

        using(FileStream  
            fileStream = new FileStream(fileName, FileMode.Create))
        {
            // Write the data to the file, byte by byte.
            for(int i = 0; i < dataArray.Length;
 i++)
            {
                fileStream.WriteByte(dataArray[i]);
            }

            // Set the stream position to the beginning of the file.
            fileStream.Seek(0, SeekOrigin.Begin);

            // Read and verify the data.
            for(int i = 0; i < fileStream.Length;
 i++)
            {
                if(dataArray[i] != fileStream.ReadByte())
                {
                    Console.WriteLine("Error writing data.");
                    return;
                }
            }
            Console.WriteLine("The data was written to {0} " +
                "and verified.", fileStream.Name);
        }
    }
}

C++

using namespace System;
using namespace System::IO;
int main()
{
   String^ fileName =  "Test@##@.dat";
   
   // Create random data to write to the file.
   array<Byte>^dataArray = gcnew array<Byte>(100000);
   (gcnew Random)->NextBytes( dataArray );
   FileStream^ fileStream = gcnew FileStream( fileName,FileMode::Create );
   try
   {
      
      // Write the data to the file, byte by byte.
      for ( int i = 0; i < dataArray->Length;
 i++ )
      {
         fileStream->WriteByte( dataArray[ i ] );

      }
      
      // Set the stream position to the beginning of the file.
      fileStream->Seek( 0, SeekOrigin::Begin );
      
      // Read and verify the data.
      for ( int i = 0; i < fileStream->Length;
 i++ )
      {
         if ( dataArray[ i ] != fileStream->ReadByte() )
         {
            Console::WriteLine( "Error writing data." );
            return  -1;
         }

      }
      Console::WriteLine( "The data was written to {0} "
      "and verified.", fileStream->Name );
   }
   finally
   {
      fileStream->Close();
   }

}

J#

import System.*;
import System.IO.*;

class FStream
{   
    public static void main(String[]
 args)
    {
        final String fileName = "Test#@@#.dat";

        // Create random data to write to the file.
        ubyte dataArray[] = new ubyte[100000];
        new Random().NextBytes(dataArray);        

        FileStream fileStream = new FileStream(fileName, FileMode.Create);
        try {
            // Write the data to the file, byte by byte.
            for(int i=0;i < dataArray.length;i++)
 {
                fileStream.WriteByte(dataArray[i]);
            } 

            // Set the stream position to the beginning of the file.
            fileStream.Seek(0, SeekOrigin.Begin);

            // Read and verify the data.
            for(int i=0;i < fileStream.get_Length();i++)
 {
                if ( dataArray[i] != fileStream.ReadByte()  )
 {
                    Console.WriteLine("Error writing data.");
                    return;
                }
            } 
            Console.WriteLine("The data was written to {0} "
                + "and verified.", fileStream.get_Name());
        }
        finally {
            fileStream.Dispose();
        }        
    } //main
} //FStream

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
FileStream クラス
FileStream メンバ
System.IO 名前空間
その他の技術情報
ファイルおよびストリーム入出力
方法 : ファイルからテキストを読み取る
方法 : ファイルにテキストを書き込む