OracleBFileクラス

OracleBFileは、BFILEデータへの参照が含まれるオブジェクトです。このオブジェクトは、BFILEに対して操作を実行するためのメソッドを提供します。

注意:

OracleBFileは、Oracle8.x以降に対して実行されるアプリケーションでサポートされています。

クラスの継承

System.Object

System.MarshalByRefObject

System.IO.Stream

Oracle.DataAccess.Types.OracleBFile

宣言

// C#
public sealed class OracleBFile : Stream, ICloneable, INullable

スレッド安全性

パブリック静的メソッドはスレッドセーフですが、インスタンス・メソッドではスレッド安全性は保証されません。

備考

OracleBFileは、Oracle8.x以降に対して実行されるアプリケーションでサポートされています。

例

// Database Setup, if you have not done so yet.
/* Log on as DBA (SYS or SYSTEM) that has CREATE ANY DIRECTORY privilege.

CREATE OR REPLACE DIRECTORY MYDIR AS 'C:\TEMP';

*/

// C#

using System;
using Oracle.DataAccess.Client;
using Oracle.DataAccess.Types;

class OracleBFileSample
{
static void Main()
{
    // Create MYDIR directory object as indicated previously and create a file
    // MyFile.txt with the text ABCDABC under C:\TEMP directory.
    // Note that the byte representation of the ABCDABC is 65666768656667

    string constr = "User Id=scott;Password=tiger;Data Source=oracle";
    OracleConnection con = new OracleConnection(constr);
    con.Open();

    OracleBFile bFile = new OracleBFile(con, "MYDIR", "MyFile.txt");

    // Open the OracleBFile
    bFile.OpenFile();

    // Read 7 bytes into readBuffer, starting at buffer offset 0
    byte[] readBuffer = new byte[7];
    int bytesRead = bFile.Read(readBuffer, 0, 7);

    // Prints "bytesRead  = 7"
    Console.WriteLine("bytesRead  = " + bytesRead);

    // Prints "readBuffer = 65666768656667"
    Console.Write("readBuffer = ");
    for(int index = 0; index <  readBuffer.Length; index++)
    {
      Console.Write(readBuffer[index]);
    }
    Console.WriteLine();

    // Search for the 2nd occurrence of a byte pattern {66,67}
    // starting from byte offset 1 in the OracleBFile
    byte[] pattern = new byte[2] {66, 67};
    long posFound = bFile.Search(pattern, 1, 2);

    // Prints "posFound   = 6"
    Console.WriteLine("posFound   = " + posFound);

    // Close the OracleBFile
    bFile.CloseFile();

    bFile.Close();
    bFile.Dispose();

    con.Close();
    con.Dispose();
}
}

要件

ネームスペース: Oracle.DataAccess.Types

アセンブリ: Oracle.DataAccess.dll

Microsoft .NET Frameworkバージョン: 1.xまたは2.0

参照:

Oracle.DataAccess.Typesネームスペース
OracleBFileメンバー
OracleBFileコンストラクタ
OracleBFile静的フィールド
OracleBFile静的メソッド
OracleBFileインスタンス・プロパティ
OracleBFileインスタンス・メソッド

OracleBFileメンバー

OracleBFileメンバーは次の表にリスト表示されています。

OracleBFileコンストラクタ

OracleBFileコンストラクタのリストを、表11-1に示します。

表11-1 OracleBFileコンストラクタ

コンストラクタ	説明
OracleBFileコンストラクタ	`OracleBFile`クラスのインスタンスを作成します（オーバーロード）

OracleBFile静的フィールド

OracleBFile静的フィールドのリストを、表11-2に示します。

表11-2 OracleBFile静的フィールド

フィールド	説明
MaxSize	静的フィールドは`BFILE`が保持できる最大バイト数、4,294,967,295（2^32 - 1）バイトを保持します
Null	`OracleBFile`インスタンスの値に割り当てることができるNULL値を表します

OracleBFile静的メソッド

OracleBFile静的メソッドのリストを、表11-3に示します。

表11-3 OracleBFile静的メソッド

メソッド	説明
`Equals`	`System.Object`からの継承（オーバーロード）

OracleBFileインスタンス・プロパティ

OracleBFileインスタンスのプロパティを、表11-4に示します。

表11-4 OracleBFileインスタンス・プロパティ

プロパティ	説明
CanRead	LOBストリームが読取り可能かどうかを示します
CanSeek	順方向および逆方向検索操作が実行可能かどうかを示します
CanWrite	LOBオブジェクトが書込みをサポートしているかどうかを示します
Connection	`BFILE`からの読取りに使用する接続を示します
DirectoryName	`BFILE`のディレクトリの別名を示します
FileExists	指定された`BFILE`が存在するかどうかを示します
FileName	`BFILE`の名前を示します
IsEmpty	`BFILE`が空かどうかを示します
IsNull	現行インスタンスにNULL値があるかどうかを示します
IsOpen	`BFILE`がこのインスタンスによってオープンされているかどうかを示します
Length	`BFILE`データのサイズをバイト数で示します
Position	LOBストリームの現行の読取り位置を示します
Value	データを`BFILE`の最初のバイトから開始するバイト配列として戻します

OracleBFileインスタンス・メソッド

OracleBFileインスタンス・メソッドのリストを、表11-5に示します。

表11-5 OracleBFileインスタンス・メソッド

メソッド	説明
`BeginRead`	`System.IO.Stream`からの継承
`BeginWrite`	サポート対象外
Clone	`OracleBFile`オブジェクトのコピーを作成します
Close	現行のストリームをクローズし、ストリームに関連するすべてのリソースを解除します
CloseFile	現行の`BFILE`インスタンスが参照する`BFILE`をクローズします
Compare	2つの`OracleBFile`が参照するデータを比較します
`CreateObjRef`	`System.MarshalByRefObject`からの継承
CopyTo	指定どおりにデータをコピーします（オーバーロード）
Dispose	このオブジェクトによって割り当てられたリソースを解除します
`EndRead`	`System.IO.Stream`からの継承
`EndWrite`	サポート対象外
`Equals`	`System.Object`からの継承（オーバーロード）
`Flush`	サポート対象外
`GetHashCode`	`System.Object`からの継承
`GetLifetimeService`	`System.MarshalByRefObject`からの継承
`GetType`	`System.Object`からの継承
`InitializeLifetimeService`	`System.MarshalByRefObject`からの継承
IsEqual	LOB参照を比較します
OpenFile	`FileName`および`DirectoryName`によって指定された`BFILE`をオープンします
Read	`OracleBFile`インスタンスから指定バイト数を読み取り、`buffer`に移入します
`ReadByte`	`System.IO.Stream`からの継承
Search	`OracleBFile`の現行インスタンスのバイナリ・パターンを検索します
Seek	現行のLOBストリームに位置を設定します
`SetLength`	サポート対象外
`ToString`	`System.Object`からの継承
`Write`	サポート対象外
`WriteByte`	サポート対象外

参照:

OracleBFileコンストラクタ

OracleBFileコンストラクタでは、OracleBFileクラスの新規インスタンスを作成します。

オーバーロード・リスト:

OracleBFile(OracleConnection)

このコンストラクタでは、OracleBFileクラスのインスタンスをOracleConnectionオブジェクトとともに作成します。
OracleBFile(OracleConnection, string, string)

このコンストラクタでは、OracleConnectionオブジェクト付きOracleBFileクラスのインスタンス、BFILEの位置およびBFILEの名前を作成します。

参照:

OracleBFile(OracleConnection)

このコンストラクタでは、OracleBFileクラスのインスタンスをOracleConnectionオブジェクトとともに作成します。

宣言

// C#
public OracleBFile(OracleConnection con);

パラメータ

con

OracleConnectionオブジェクト

例外

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

接続は、アプリケーションによって明示的にオープンされる必要があります。OracleBFileでは接続を暗黙的にオープンしません。

参照:

OracleBFile(OracleConnection, string, string)

このコンストラクタでは、OracleConnectionオブジェクト付きOracleBFileクラスのインスタンス、BFILEの位置およびBFILEの名前を作成します。

宣言

// C#
public OracleBFile(OracleConnection con, string directoryName, string
   fileName);

パラメータ

con

OracleConnectionオブジェクト
directoryName

CREATE DIRECTORY SQL文によって作成されたディレクトリの別名
fileName

外部LOBの名前

例外

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

OracleConnectionは、アプリケーションによって明示的にオープンされる必要があります。OracleBFileでは接続を暗黙的にオープンしません。

OracleBFileインスタンスを使用してBFILE列をSQL INSERT文の入力パラメータとして初期化するには、directoryNameおよびfileNameを正しく設定する必要があります。

参照:

OracleBFile静的フィールド

OracleBFile静的フィールドのリストを、表11-6に示します。

表11-6 OracleBFile静的フィールド

フィールド	説明
MaxSize	静的フィールドは`BFILE`が保持できる最大バイト数、4,294,967,295（2^32 - 1）バイトを保持します
Null	`OracleBFile`インスタンスの値に割り当てることができるNULL値を表します

参照:

MaxSize

この静的フィールドはBFILEが保持できる最大バイト数、4,294,967,295（2^32 - 1）バイトを保持します。

宣言

// C#
public static readonly Int64 MaxSize = 4294967295;

備考

このフィールドは操作が許容最大長を超えているかどうかをチェックするコードに便利です。

参照:

Null

この静的フィールドは、OracleBFileインスタンスの値に割り当てることができるNULL値を表します。

宣言

// C#
public static readonly OracleBFile Null;

参照:

OracleBFile静的メソッド

OracleBFile静的メソッドのリストを、表11-7に示します。

表11-7 OracleBFile静的メソッド

メソッド	説明
`Equals`	`System.Object`からの継承（オーバーロード）

参照:

OracleBFileインスタンス・プロパティ

OracleBFileインスタンスのプロパティを、表11-8に示します。

表11-8 OracleBFileインスタンス・プロパティ

プロパティ	説明
CanRead	LOBストリームが読取り可能かどうかを示します
CanSeek	順方向および逆方向検索操作が実行可能かどうかを示します
CanWrite	LOBオブジェクトが書込みをサポートしているかどうかを示します
Connection	`BFILE`からの読取りに使用する接続を示します
DirectoryName	`BFILE`のディレクトリの別名を示します
FileExists	指定された`BFILE`が存在するかどうかを示します
FileName	`BFILE`の名前を示します
IsEmpty	`BFILE`が空かどうかを示します
IsNull	現行インスタンスにNULL値があるかどうかを示します
IsOpen	`BFILE`がこのインスタンスによってオープンされているかどうかを示します
Length	`BFILE`データのサイズをバイト数で示します
Position	LOBストリームの現行の読取り位置を示します
Value	データを`BFILE`の最初のバイトから開始するバイト配列として戻します

参照:

CanRead

Streamをオーバーライドします。

このインスタンス・プロパティではLOBストリームが読取り可能かどうかを示します。

宣言

// C#
public override bool CanRead{get;}

プロパティ値

LOBストリームが読取り可能の場合はtrueを戻し、それ以外の場合はfalseを戻します。

参照:

CanSeek

Streamをオーバーライドします。

このインスタンス・プロパティでは、順方向および逆方向シーク操作が実行可能かどうかを示します。

宣言

// C#
public override bool CanSeek{get;}

プロパティ値

順方向および逆方向シーク操作が実行可能の場合はtrueを戻し、それ以外の場合はfalseを戻します。

参照:

CanWrite

Streamをオーバーライドします。

このインスタンス・プロパティでは、LOBオブジェクトが書込みをサポートしているかどうかを示します。

宣言

// C#
public override bool CanWrite{get;}

プロパティ値

BFILEは読取り専用

備考

BFILEは読取り専用であるため、ブール値は常にfalseです。

参照:

Connection

このインスタンス・プロパティでは、BFILEからの読取りに使用する接続を示します。

宣言

// C#
public OracleConnection Connection {get;}

プロパティ値

OracleConnectionのオブジェクト

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

参照:

DirectoryName

このインスタンス・プロパティでは、BFILEのディレクトリの別名を示します。

宣言

// C#
public string DirectoryName {get;set;}

プロパティ値

string

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: BFILEがオープンされているときに変更されたDirectoryNameの値。

備考

DirectoryNameの最大長は30バイトです。

参照:

FileExists

このインスタンス・プロパティでは、DirectoryNameおよびFileNameによって指定されたBFILEが存在するかどうかを示します。

宣言

// C#
public bool FileExists {get;}

プロパティ値

bool

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

接続、ファイル名およびディレクトリ名が指定されていない場合は、このプロパティはデフォルトでfalseに設定されます。

参照:

FileName

このインスタンス・プロパティでは、BFILEの名前を示します。

宣言

// C#
public string FileName {get;set}

プロパティ値

BFILE名を含むstring

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: BFILEがオープンされているときに変更されたDirectoryNameの値。

備考

FileNameの最大長は255バイトです。

BFILEオブジェクトがオープンされているときにFileNameプロパティを変更すると例外が発生します。

参照:

IsEmpty

このインスタンス・プロパティでは、BFILEが空かどうかを示します。

宣言

// C#
public bool IsEmpty {get;}

プロパティ値

bool

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

参照:

IsNull

このプロパティは現行インスタンスにNULL値があるかどうかを示します。

宣言

// C#
public bool IsNull{get;}

プロパティ値

現行インスタンスにNULL値がある場合はtrue、それ以外の場合はfalseを戻します。

参照:

IsOpen

このインスタンス・プロパティでは、BFILEがこのインスタンスによってオープンされているかどうかを示します。

宣言

// C#
public bool IsOpen {get;}

プロパティ値

bool

参照:

Length

Streamをオーバーライドします。

このインスタンス・プロパティでは、BFILEデータのサイズをバイト数で示します。

宣言

// C#
public override Int64 Length {get;}

プロパティ値

Int64

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

参照:

Position

Streamをオーバーライドします。

このインスタンスではLOBストリームの現行の読取り位置を示します。

宣言

// C#
public override Int64 Position{get; set;}

プロパティ値

読取り位置を示すInt64値

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

ArgumentOutOfRangeException: 値は0未満です。

参照:

Value

このインスタンス・プロパティでは、データをBFILEの最初のバイトを起点とするバイト配列として戻します。

宣言

// C#
public byte[] Value{get;}

プロパティ値

バイト配列

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

データ長はバイト配列の最大長によって制限されています。Positionプロパティの現行値は使用または変更されません。

参照:

OracleBFileインスタンス・メソッド

OracleBFileインスタンス・メソッドのリストを、表11-9に示します。

表11-9 OracleBFileインスタンス・メソッド

メソッド	説明
`BeginRead`	`System.IO.Stream`からの継承
`BeginWrite`	サポート対象外
Clone	`OracleBFile`オブジェクトのコピーを作成します
Close	現行のストリームをクローズし、ストリームに関連するすべてのリソースを解除します
CloseFile	現行の`BFILE`インスタンスが参照する`BFILE`をクローズします
Compare	2つの`OracleBFile`が参照するデータを比較します
`CreateObjRef`	`System.MarshalByRefObject`からの継承
CopyTo	指定どおりにデータをコピーします（オーバーロード）
Dispose	このオブジェクトによって割り当てられたリソースを解除します
`EndRead`	`System.IO.Stream`からの継承
`EndWrite`	サポート対象外
`Equals`	`System.Object`からの継承（オーバーロード）
`Flush`	サポート対象外
`GetHashCode`	`System.Object`からの継承
`GetLifetimeService`	`System.MarshalByRefObject`からの継承
`GetType`	`System.Object`からの継承
`InitializeLifetimeService`	`System.MarshalByRefObject`からの継承
IsEqual	LOB参照を比較します
OpenFile	`FileName`および`DirectoryName`によって指定された`BFILE`をオープンします
Read	`OracleBFile`インスタンスから指定バイト数を読み取り、`buffer`に移入します
`ReadByte`	`System.IO.Stream`からの継承
Search	`OracleBFile`の現行インスタンスのバイナリ・パターンを検索します
Seek	現行のLOBストリームに位置を設定します
`SetLength`	サポート対象外
`ToString`	`System.Object`からの継承
`Write`	サポート対象外
`WriteByte`	サポート対象外

参照:

Clone

このインスタンス・メソッドではOracleBFileオブジェクトのコピーを作成します。

宣言

// C#
public object Clone();

戻り値

OracleBFileオブジェクト

実装

ICloneable

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

複製されたオブジェクトのプロパティ値は、複製元のオブジェクトのプロパティ値と同じです。

例

// Database Setup, if you have not done so yet.
/* Log on as DBA (SYS or SYSTEM) that has CREATE ANY DIRECTORY privilege.

CREATE OR REPLACE DIRECTORY MYDIR AS 'C:\TEMP';

*/

// C#

using System;
using Oracle.DataAccess.Client;
using Oracle.DataAccess.Types;

class CloneSample
{
  static void Main()
  {
    // Create MYDIR directory object as indicated previously and create a file
    // MyFile.txt with the text ABCDABC under C:\TEMP directory.
    // Note that the byte representation of the ABCDABC is 65666768656667

    string constr = "User Id=scott;Password=tiger;Data Source=oracle";
    OracleConnection con = new OracleConnection(constr);
    con.Open();

    OracleBFile bFile1 = new OracleBFile(con, "MYDIR", "MyFile.txt");

    // Prints "bFile1.Position = 0"
    Console.WriteLine("bFile1.Position = " + bFile1.Position);

    // Set the Position before calling Clone()
    bFile1.Position = 1;

    // Clone the OracleBFile
    OracleBFile bFile2 = (OracleBFile) bFile1.Clone();

    // Prints "bFile2.Position = 1"
    Console.WriteLine("bFile2.Position = " + bFile2.Position);

    bFile1.Close();
    bFile1.Dispose();

    bFile2.Close();
    bFile2.Dispose();

    con.Close();
    con.Dispose();
  }
}

参照:

Close

Streamをオーバーライドします。

このインスタンス・メソッドは現行のストリームをクローズし、それに関連する任意のリソースを解放します。

宣言

// C#
public override void Close();

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

参照:

CloseFile

このインスタンス・メソッドでは、現行のBFILEインスタンスが参照するBFILEをクローズします。

宣言

// C#
public void CloseFile();

備考

BFILEが存在しているがオープンされていない場合は、エラーは戻されません。

参照:

Compare

このインスタンス・メソッドでは、2つのOracleBFileが参照するデータを比較します。

宣言

// C#
public int Compare(Int64 src_offset, OracleBFile obj, Int64 dst_offset,
    Int64 amount);

パラメータ

src_offset

現行インスタンスのオフセット
obj

指定されたOracleBFileオブジェクト
dst_offset

OracleBFileオブジェクトのオフセット
amount

比較するバイト数

戻り値

次の数を戻します。

ゼロ未満: 現行のインスタンスのBFILEデータが指定されたBFILEデータの値より小さい場合
ゼロ: どちらのBFILEにも同じデータが格納されている場合
ゼロ超過: 現行のインスタンスのBFILEデータが指定されたBFILEデータの値より大きい場合

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

ArgumentOutOfRangeException: src_offset、dst_offset、またはamountは0未満です。

備考

指定されたオブジェクトと現行のインスタンスには、同じ接続を使用する必要があります。つまり、同じOracleConnectionオブジェクトを使用します。

BFILEは、操作前にOpenFileを使用してオープンされている必要があります。

例

// Database Setup, if you have not done so yet.
/* Log on as DBA (SYS or SYSTEM) that has CREATE ANY DIRECTORY privilege.

CREATE OR REPLACE DIRECTORY MYDIR AS 'C:\TEMP';

*/

// C#

using System;
using Oracle.DataAccess.Client;
using Oracle.DataAccess.Types;

class CompareSample
{
  static void Main()
  {
    // Create MYDIR directory object as indicated previously and create a file
    // MyFile.txt with the text ABCDABC under C:\TEMP directory.
    // Note that the byte representation of the ABCDABC is 65666768656667

    string constr = "User Id=scott;Password=tiger;Data Source=oracle";
    OracleConnection con = new OracleConnection(constr);
    con.Open();

    OracleBFile bFile1 = new OracleBFile(con, "MYDIR", "MyFile.txt");
    OracleBFile bFile2 = new OracleBFile(con, "MYDIR", "MyFile.txt");

    // Open the OracleBFiles
    bFile1.OpenFile();
    bFile2.OpenFile();

    // Compare 2 bytes from the 1st byte of bFile1 and
    // the 5th byte of bFile2 onwards
    int result = bFile1.Compare(1, bFile2, 5, 2);

    // Prints "result = 0" (Indicates the data is identical)
    Console.WriteLine("result = " + result);

    // Close the OracleBFiles
    bFile1.CloseFile();
    bFile2.CloseFile();

    bFile1.Close();
    bFile1.Dispose();

    bFile2.Close();
    bFile2.Dispose();

    con.Close();
    con.Dispose();
  }
}

参照:

CopyTo

CopyToでは、現行のインスタンスから指定されたオブジェクトにデータをコピーします。

オーバーロード・リスト:

CopyTo(OracleBlob)

このインスタンス・メソッドでは、現行のインスタンスから指定されたOracleBlobオブジェクトにデータをコピーします。
CopyTo(OracleBlob, Int64)

このインスタンス・メソッドでは、データを現行のOracleBFileインスタンスから指定されたOracleBlobオブジェクトに、指定されたオフセット先とともにコピーします。
CopyTo(Int64, OracleBlob, Int64, Int64)

このインスタンス・メソッドでは、データを現行のOracleBFileインスタンスから、指定されたソース・オフセット、オフセット先および文字数とともに指定されたOracleBlobオブジェクトにコピーします。
CopyTo(OracleClob)

このインスタンス・メソッドでは、現行のOracleBFileインスタンスから指定されたOracleClobオブジェクトにデータをコピーします。
CopyTo(OracleClob, Int64)

このインスタンス・メソッドでは、データを現行のOracleBFileインスタンスから指定されたOracleClobオブジェクトに指定されたオフセット先とともにコピーします。
CopyTo(Int64, OracleClob, Int64, Int64)

このインスタンス・メソッドでは、データを現行のOracleBFileインスタンスから指定されたOracleClobオブジェクトに指定されたソース・オフセット、オフセット先および文字数とともにコピーします。

参照:

CopyTo(OracleBlob)

このインスタンス・メソッドでは、現行のインスタンスから指定されたOracleBlobオブジェクトにデータをコピーします。

宣言

// C#
public Int64 CopyTo(OracleBlob obj);

パラメータ

obj

データのコピー先のOracleBlobオブジェクト

戻り値

戻り値はコピーされた数

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: この例外は次のいずれかの条件が存在する場合に表示されます。

OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされた場合
LOBオブジェクト・パラメータにオブジェクト以外の接続がある場合

備考

指定されたオブジェクトと現行のインスタンスには、同じ接続を使用する必要があります。つまり、同じOracleConnectionオブジェクトを使用します。

参照:

CopyTo(OracleBlob, Int64)

このインスタンス・メソッドでは、データを現行のOracleBFileインスタンスから指定されたOracleBlobオブジェクトに、指定されたオフセット先とともにコピーします。

宣言

// C#
public Int64 CopyTo(OracleBlob obj, Int64 dst_offset);

パラメータ

obj

データのコピー先のOracleBlobオブジェクト
dst_offset

OracleBlobオブジェクトをコピーするオフセット（バイト）

戻り値

戻り値はコピーされた数

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentOutOfRangeException: dst_offsetは0未満です。

InvalidOperationException: この例外は次のいずれかの条件が存在する場合に表示されます。

OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされた場合
LOBオブジェクト・パラメータにオブジェクト以外の接続がある場合

備考

dst_offsetが、OracleBlobデータの終点を超えている場合は、dst_offsetに到達するまで、OracleBlobに空白が書き込まれます。

オフセットは0ベースです。この操作で文字変換は実行されません。

指定されたオブジェクトと現行のインスタンスには、同じ接続を使用する必要があります。つまり、同じOracleConnectionオブジェクトを使用します。

参照:

CopyTo(Int64, OracleBlob, Int64, Int64)

このインスタンス・メソッドでは、データを現行のOracleBFileインスタンスから、指定されたソース・オフセット、オフセット先および文字数とともに指定されたOracleBlobオブジェクトにコピーします。

宣言

// C#
public Int64 CopyTo(Int64 src_offset,OracleBlob obj,Int64 dst_offset,
   Int64 amount);

パラメータ

src_offset

データの読取り元の現行インスタンス内のオフセット（バイト）
obj

データのコピー先のOracleBlobオブジェクト
dst_offset

OracleBlobオブジェクトのコピー先のオフセット（バイト）
amount

コピーするデータ容量

戻り値

戻り値はコピーされた数

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentOutOfRangeException: src_offset、dst_offset、またはamountは0未満です。

InvalidOperationException: この例外は次のいずれかの条件が存在する場合に表示されます。

OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされた場合
LOBオブジェクト・パラメータにオブジェクト以外の接続がある場合

備考

dst_offsetが、OracleBlobデータの終点を超えている場合は、dst_offsetに到達するまで、OracleBlobに空白が書き込まれます。

オフセットは0ベースです。この操作で文字変換は実行されません。

指定されたオブジェクトと現行のインスタンスには、同じ接続を使用する必要があります。つまり、同じOracleConnectionオブジェクトを使用します。

参照:

CopyTo(OracleClob)

このインスタンス・メソッドでは、現行のOracleBFileインスタンスから指定されたOracleClobオブジェクトにデータをコピーします。

宣言

// C#
public Int64 CopyTo(OracleClob obj);

パラメータ

obj

データのコピー先のOracleClobオブジェクト

戻り値

戻り値はコピーされた数

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: この例外は次のいずれかの条件が存在する場合に表示されます。

OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされた場合
LOBオブジェクト・パラメータにオブジェクト以外の接続がある場合

備考

指定されたオブジェクトと現行のインスタンスには、同じ接続を使用する必要があります。つまり、同じOracleConnectionオブジェクトを使用します。

参照:

CopyTo(OracleClob, Int64)

このインスタンス・メソッドでは、データを現行のOracleBFileインスタンスから指定されたOracleClobオブジェクトに指定されたオフセット先とともにコピーします。

宣言

// C#
public Int64 CopyTo(OracleClob obj, Int64 dst_offset);

パラメータ

obj

データのコピー先のOracleClobオブジェクト
dst_offset

OracleClobオブジェクトをコピーするオフセット（文字）

戻り値

コピーした数

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentOutOfRangeException: dst_offsetは0未満です。

InvalidOperationException: この例外は次のいずれかの条件が存在する場合に表示されます。

OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされた場合
LOBオブジェクト・パラメータにオブジェクト以外の接続がある場合

備考

dst_offsetが、OracleClobデータの終点を超えている場合は、dst_offsetに到達するまで、OracleClobに空白が書き込まれます。

オフセットは0ベースです。この操作で文字変換は実行されません。

指定されたオブジェクトと現行のインスタンスには、同じ接続を使用する必要があります。つまり、同じOracleConnectionオブジェクトを使用します。

参照:

CopyTo(Int64, OracleClob, Int64, Int64)

このインスタンス・メソッドでは、データを現行のOracleBFileインスタンスから指定されたOracleClobオブジェクトに指定されたソース・オフセット、オフセット先および文字数とともにコピーします。

宣言

// C#
public Int64 CopyTo(Int64 src_offset,OracleClob obj,Int64 dst_offset,
   Int64 amount);

パラメータ

src_offset

データの読取り元の現行インスタンス内のオフセット（文字）
obj

データのコピー先のOracleClobオブジェクト
dst_offset

OracleClobオブジェクトをコピーするオフセット（文字）
amount

コピーするデータ容量

戻り値

戻り値はコピーされた数

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

ArgumentOutOfRangeException: src_offset、dst_offset、またはamountは0未満です。

InvalidOperationException: この例外は次のいずれかの条件が存在する場合に表示されます。

OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされた場合
LOBオブジェクト・パラメータにオブジェクト以外の接続がある場合

備考

dst_offsetが、現在のOracleClobデータの終点を超えている場合は、dst_offsetに到達するまで、OracleClobに空白が書き込まれます。

オフセットは0ベースです。この操作で文字変換は実行されません。

指定されたオブジェクトと現行のインスタンスには、同じ接続を使用する必要があります。つまり、同じOracleConnectionオブジェクトを使用します。

参照:

Dispose

このインスタンス・メソッドでは、このオブジェクトによって割り当てられたリソースを解除します。

宣言

// C#
public void Dispose();

実装

IDisposable

備考

引き続き一部のプロパティにアクセスすることはできますが、その値は信頼できません。リソースが解除されているため、メソッドを呼び出すと例外となる可能性があります。オブジェクトは、処理後は再度使用できません。

参照:

IsEqual

このインスタンスではLOB参照を比較します。

宣言

// C#
public bool IsEqual(OracleBFile obj);

パラメータ

obj

指定されたOracleBFileオブジェクト

戻り値

現行のOracleBFileおよび指定されたOracleBFileオブジェクトが同じ外部LOBを参照する場合は、trueを戻します。それ以外の場合はfalseを戻します。

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

2つの異なるOracleBFileインスタンスが同じ外部LOBを参照できるため、2つのOracleBFileオブジェクトが==またはEquals()に対してfalseを戻しても、このメソッドではtrueを戻すことができます。

指定されたオブジェクトと現行のインスタンスには、同じ接続を使用する必要があります。つまり、同じOracleConnectionオブジェクトを使用します。

参照:

OpenFile

このインスタンス・メソッドでは、FileNameおよびDirectoryNameによって指定されたBFILEをオープンします。

宣言

// C#
public void OpenFile();

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

Compare()、CopyTo()、Read()およびSearch()などの多くの操作の場合は、操作前にOpenFileを使用してBFILEをオープンしておく必要があります。

オープンしたBFILEでのOpenFileの呼出しはできません。

参照:

Read

Streamをオーバーライドします。

このインスタンス・メソッドでは、OracleBFileインスタンスから指定バイト数を読み取り、bufferを移入します。

宣言

// C#
public override int Read(byte[ ] buffer, int offset, int count);

パラメータ

buffer

移入されるバイト配列バッファ
offset

移入されるバイト配列バッファのオフセット
count

読取りバイト数

戻り値

この戻り値は、BFILE、つまり外部LOBから読み取られるバイト数を示します。

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

ArgumentOutOfRangeException: offsetまたはcountパラメータが0未満、offsetがbuffer.Length以上、またはoffsetとcountの合計がbuffer.Lengthより大きい場合のいずれか。

備考

LOBデータの読取りは、Positionプロパティにより指定された位置から開始されます。

例

// Database Setup, if you have not done so yet.
/* Log on as DBA (SYS or SYSTEM) that has CREATE ANY DIRECTORY privilege.

CREATE OR REPLACE DIRECTORY MYDIR AS 'C:\TEMP';

*/

// C#

using System;
using Oracle.DataAccess.Client;
using Oracle.DataAccess.Types;

class ReadSample
{
  static void Main()
  {
    // Create MYDIR directory object as indicated previously and create a file
    // MyFile.txt with the text ABCDABC under C:\TEMP directory.
    // Note that the byte representation of the ABCDABC is 65666768656667

    string constr = "User Id=scott;Password=tiger;Data Source=oracle";
    OracleConnection con = new OracleConnection(constr);
    con.Open();

    OracleBFile bFile = new OracleBFile(con, "MYDIR", "MyFile.txt");

    // Open the OracleBFile
    bFile.OpenFile();

    // Read 7 bytes into readBuffer, starting at buffer offset 0
    byte[] readBuffer = new byte[7];
    int bytesRead = bFile.Read(readBuffer, 0, 7);

    // Prints "bytesRead  = 7"
    Console.WriteLine("bytesRead  = " + bytesRead);

    // Prints "readBuffer = 65666768656667"
    Console.Write("readBuffer = ");
    for(int index = 0; index <  readBuffer.Length; index++)
    {
      Console.Write(readBuffer[index]);
    }
    Console.WriteLine();

    // Close the OracleBFile
    bFile.CloseFile();

    bFile.Close();
    bFile.Dispose();

    con.Close();
    con.Dispose();
  }
}

参照:

Search

このインスタンス・メソッドでは、OracleBFileの現行のインスタンスのバイナリ・パターンを検索します。

宣言

// C#
public int Search(byte[ ] val, Int64 offset, Int64 nth);

パラメータ

val

検索対象のバイナリ・パターン
offset

OracleBFileの検索が開始される0ベース・オフセット（バイト）
nth

オフセットが戻される特定の一致の状態（1ベース）

戻り値

一致のnth回目の出現に対して、一致パターン（バイト表示）の起点の絶対offsetを戻します。それ以外の場合は、0が戻されます。

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

ArgumentOutOfRangeException: offsetが0未満の場合、nthが0以下の場合、val.Lengthが16383より大きい場合、nthがOracleBFile.MaxSize以上の場合またはoffsetがOracleBFile.MaxSize以上の場合のいずれか。

備考

検索パターンの制限は16383バイトです。

例

// Database Setup, if you have not done so yet.
/* Log on as DBA (SYS or SYSTEM) that has CREATE ANY DIRECTORY privilege.

CREATE OR REPLACE DIRECTORY MYDIR AS 'C:\TEMP';

*/

// C#

using System;
using Oracle.DataAccess.Client;
using Oracle.DataAccess.Types;

class SearchSample
{
  static void Main()
  {
    // Create MYDIR directory object as indicated previously and create a file
    // MyFile.txt with the text ABCDABC under C:\TEMP directory.
    // Note that the byte representation of the ABCDABC is 65666768656667

    string constr = "User Id=scott;Password=tiger;Data Source=oracle";
    OracleConnection con = new OracleConnection(constr);
    con.Open();

    OracleBFile bFile = new OracleBFile(con, "MYDIR", "MyFile.txt");

    // Open the OracleBFile
    bFile.OpenFile();

    // Search for the 2nd occurrence of a byte pattern {66,67}
    // starting from byte offset 1 in the OracleBFile
    byte[] pattern = new byte[2] {66, 67};
    long posFound = bFile.Search(pattern, 1, 2);

    // Prints "posFound = 6"
    Console.WriteLine("posFound = " + posFound);

    // Close the OracleBFile
    bFile.CloseFile();

    bFile.Close();
    bFile.Dispose();

    con.Close();
    con.Dispose();
  }
}

参照:

Seek

Streamをオーバーライドします。

このインスタンス・メソッドでは現行のLOBストリームに位置を設定します。

宣言

// C#
public override Int64 Seek(Int64 offset, SeekOrigin origin);

パラメータ

offset

起点に相対的なバイト・オフセット
origin

新規位置を取得する場合に使用する参照ポイントを示すタイプSystem.IO.SeekOriginの値

戻り値

位置を示すInt64が戻されます。

例外

ObjectDisposedException: オブジェクトはすでに処理されています。

InvalidOperationException: OracleConnectionがオープンされていないか、またはオブジェクトの存続中にクローズされています。

備考

offsetが負の場合は、新規位置がoffsetによって指定されたバイト数だけ、originで指定した位置より前にあります。

offsetがゼロの場合は、originで指定した位置が新規位置となります。

offsetが正の場合は、新規位置はoffsetによって指定されたバイト数だけ、originで指定した位置より後にあります。

SeekOrigin.Beginはストリームの開始を指定します。

SeekOrigin.Currentはストリーム内の現行位置を指定します。

SeekOrigin.Endはストリームの終点を指定します。

例

// Database Setup, if you have not done so yet.
/* Log on as DBA (SYS or SYSTEM) that has CREATE ANY DIRECTORY privilege.

CREATE OR REPLACE DIRECTORY MYDIR AS 'C:\TEMP';

*/

// C#

using System;
using System.IO;
using Oracle.DataAccess.Client;
using Oracle.DataAccess.Types;

class SeekSample
{
  static void Main()
  {
    // Create MYDIR directory object as indicated previously and create a file
    // MyFile.txt with the text ABCDABC under C:\TEMP directory.
    // Note that the byte representation of the ABCDABC is 65666768656667

    string constr = "User Id=scott;Password=tiger;Data Source=oracle";
    OracleConnection con = new OracleConnection(constr);
    con.Open();

    OracleBFile bFile = new OracleBFile(con, "MYDIR", "MyFile.txt");

    // Open the OracleBFile
    bFile.OpenFile();

    // Set the Position to 2 with respect to SeekOrigin.Begin
    long newPosition = bFile.Seek(2, SeekOrigin.Begin);

    // Prints "newPosition     = 2"
    Console.WriteLine("newPosition     = " + newPosition);

    // Prints "bFile.Position  = 2"
    Console.WriteLine("bFile.Position  = " + bFile.Position);

    // Read 2 bytes into readBuffer, starting at buffer offset 1
    byte[] readBuffer = new byte[4];
    int bytesRead = bFile.Read(readBuffer, 1, 2);

    // Prints "bytesRead       = 2"
    Console.WriteLine("bytesRead       = " + bytesRead);

    // Prints "readBuffer      = 067680"
    Console.Write("readBuffer      = ");
    for(int index = 0; index <  readBuffer.Length; index++)
    {
      Console.Write(readBuffer[index]);
    }
    Console.WriteLine();

    // Close the OracleBFile
    bFile.CloseFile();

    bFile.Close();
    bFile.Dispose();

    con.Close();
    con.Dispose();
  }
}

参照: