Oracle® Data Provider for .NET開発者ガイド ODAC 12c リリース4 (12.1.0.2) for Microsoft Windows E72575-01 |
|
前 |
次 |
OracleClob
は、CLOB
データへの参照が含まれるオブジェクトです。このオブジェクトは、CLOB
に対して操作を実行するためのメソッドを提供します。
注意: OracleClob オブジェクトでは、.NET Frameworkバイト配列を使用したCLOB データの取得または書込み時に、クライアント側のキャラクタ・セットが使用されます。 |
クラスの継承
System.Object
System.MarshalByRefObject
System.IO.Stream
Oracle.DataAccess.Types.OracleClob
宣言
// C# public sealed class OracleClob : Stream, ICloneable, INullable
要件
プロバイダ | ODP.NET管理対象外ドライバ | ODP.NET管理対象ドライバ |
アセンブリ | Oracle.DataAccess.dll |
Oracle.ManagedDataAccess.dll |
ネームスペース | Oracle.DataAccess.Types |
Oracle.ManagedDataAccess.Types |
.NET Framework | 3.5, 4.0, 4.5, 4.6 | 4.0, 4.5, 4.6 |
スレッド安全性
パブリック静的メソッドはスレッドセーフですが、インスタンス・メソッドではスレッド安全性は保証されません。
例
// C# using System; using Oracle.DataAccess.Client; using Oracle.DataAccess.Types; class OracleClobSample { static void Main() { string constr = "User Id=scott;Password=tiger;Data Source=oracle"; OracleConnection con = new OracleConnection(constr); con.Open(); OracleClob clob = new OracleClob(con); // Write 4 chars from writeBuffer, starting at buffer offset 0 char[] writeBuffer = new char[4] {'a', 'b', 'c', 'd'}; clob.Write(writeBuffer, 0, 4); // Append first 2 chars from writeBuffer {'a', 'b'} to the oracleClob clob.Append(writeBuffer, 0, 2); // Prints "clob.Length = 12" Console.WriteLine("clob.Length = " + clob.Length); // Reset the Position for the Read clob.Position = 0; // Read 6 chars into readBuffer, starting at buffer offset 0 char[] readBuffer = new char[6]; int charsRead = clob.Read(readBuffer, 0, 6); // Prints "charsRead = 6" Console.WriteLine("charsRead = " + charsRead); // Prints "readBuffer = abcdab" Console.Write("readBuffer = "); for(int index = 0; index < readBuffer.Length; index++) { Console.Write(readBuffer[index]); } Console.WriteLine(); // Search for the 2nd occurrence of a char pattern 'ab' // starting from char offset 0 in the OracleClob char[] pattern = new char[2] {'a', 'b'}; long posFound = clob.Search(pattern, 0, 2); // Prints "posFound = 5" Console.WriteLine("posFound = " + posFound); // Erase 4 chars of data starting at char offset 1 // Sets chars to '' clob.Erase(1, 4); //Prints "clob.Value = a b" Console.WriteLine("clob.Value = " + clob.Value); clob.Close(); clob.Dispose(); con.Close(); con.Dispose(); } }
OracleClob
メンバーは次の表にリスト表示されています。
OracleClobコンストラクタ
OracleClob
コンストラクタを、表13-19にリストします。
OracleClob静的フィールド
OracleClob
静的フィールドを、表13-20にリストします。
表13-20 OracleClob静的フィールド
フィールド | 説明 |
---|---|
|
|
|
|
OracleClob静的メソッド
OracleClob
静的メソッドを、表13-21にリストします。
OracleClobインスタンス・プロパティ
OracleClob
インスタンス・プロパティを、表13-22にリストします。
表13-22 OracleClobインスタンス・プロパティ
プロパティ | 説明 |
---|---|
|
LOBストリームが読取り可能かどうかを示します |
|
順方向および逆方向検索操作が実行可能かどうかを示します |
|
LOBストリームが書込み可能かどうかを示します |
|
|
|
|
|
|
|
|
|
現行インスタンスにNULL値があるかどうかを示します |
|
現行インスタンスが一時 |
|
|
|
読取りまたは書込み操作中にデータベースから取得または送信する最小バイト数を示します |
|
LOBストリームの現行の読取りまたは書込み位置をバイト表示で示します |
|
データを |
OracleClobインスタンス・メソッド
OracleClob
インスタンス・メソッドを、表13-23にリストします。
表13-23 OracleClobインスタンス・メソッド
メソッド | 説明 |
---|---|
|
現行の |
|
|
|
|
|
|
|
|
|
現行のストリームをクローズし、関連するすべてのリソースを解除します |
|
現行インスタンスが参照するデータと指定されたオブジェクトのデータを比較します |
|
|
|
|
|
このオブジェクトによって割り当てられたリソースを解除します |
|
現行の |
|
|
|
|
|
|
|
指定されたデータ |
|
サポート対象外 |
|
現行インスタンスのハッシュ・コードを戻します |
|
|
|
|
|
|
|
2つの |
|
現行インスタンスから読み取ります(オーバーロード) |
|
|
|
|
|
現行のLOBストリームに位置を設定します |
|
|
|
|
|
指定された |
|
|
OracleClob
コンストラクタでは、一時CLOB
にバインドされたOracleClob
クラスのインスタンスを作成します。
オーバーロード・リスト:
このコンストラクタでは、一時CLOB
にバインドされたOracleClob
クラスのインスタンスをOracleConnection
オブジェクトとともに作成します。
OracleClob(OracleConnection, bool, bool)
このコンストラクタでは、一時CLOB
にバインドされたOracleClob
クラスのインスタンスを、OracleConnection
オブジェクト、キャッシング用のブール値およびNCLOB
用ブール値とともに作成します。
このコンストラクタでは、一時CLOB
にバインドされたOracleClob
クラスのインスタンスをOracleConnection
オブジェクトとともに作成します。
宣言
// C#
public OracleClob(OracleConnection con);
パラメータ
con
OracleConnection
オブジェクト。
例外
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
備考
接続は、アプリケーションによって明示的にオープンされる必要があります。OracleClob
では、接続を暗黙的にオープンしません。一時CLOB
では、指定された接続を使用してCLOB
データを格納します。デフォルトではキャッシングは有効化されていません。
このコンストラクタでは、一時CLOB
にバインドされたOracleClob
クラスのインスタンスを、OracleConnection
オブジェクト、キャッシング用のブール値およびNCLOB
用ブール値とともに作成します。
宣言
// C# public OracleClob(OracleConnection con, bool bCaching, bool bNCLOB);
パラメータ
con
OracleConnection
オブジェクト接続
bCaching
サーバー側のキャッシングが有効化されているかどうかを示すフラグ
bNCLOB
インスタンスがNCLOB
の場合はtrue
に、CLOB
の場合はfalse
に設定されるフラグ
例外
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
備考
接続は、アプリケーションによって明示的にオープンされる必要があります。OracleClob
では、接続を暗黙的にオープンしません。一時CLOB
またはNCLOB
では、指定された接続を使用してCLOB
データを格納します。
OracleClob
静的フィールドを、表13-24にリストします。
表13-24 OracleClob静的フィールド
フィールド | 説明 |
---|---|
|
|
|
|
MaxSize
フィールドでは、CLOB
が保持できる最大バイト数、4,294,967,295(2^32 - 1)バイトを保持します。
宣言
// C# public static readonly Int64 MaxSize = 4294967295;
備考
このフィールドは、ユーザー操作が許容最大長(バイト表示)を超えているかどうかをチェックするコードに便利です。
OracleClob
インスタンス・プロパティを、表13-26にリストします。
表13-26 OracleClobインスタンス・プロパティ
プロパティ | 説明 |
---|---|
|
LOBストリームが読取り可能かどうかを示します |
|
順方向および逆方向検索操作が実行可能かどうかを示します |
|
LOBストリームが書込み可能かどうかを示します |
|
|
|
|
|
|
|
|
|
現行インスタンスにNULL値があるかどうかを示します |
|
現行インスタンスが一時 |
|
|
|
読取りまたは書込み操作中にデータベースから取得または送信する最小バイト数を示します |
|
LOBストリームの現行の読取りまたは書込み位置をバイト表示で示します |
|
データを |
Stream
をオーバーライドします
このインスタンス・プロパティではLOBストリームが読取り可能かどうかを示します。
宣言
// C# public override bool CanRead{get;}
プロパティ値
LOBストリームが読取り可能の場合はtrue
を戻し、それ以外の場合はfalse
を戻します。
Stream
をオーバーライドします
このインスタンス・プロパティでは、順方向および逆方向シーク操作が実行可能かどうかを示します。
宣言
// C# public override bool CanSeek{get;}
プロパティ値
順方向および逆方向シーク操作が実行可能の場合はtrue
を戻し、それ以外の場合はfalse
を戻します。
Stream
をオーバーライドします
このインスタンス・プロパティでは、LOBオブジェクトが書込みをサポートしているかどうかを示します。
宣言
// C# public override bool CanWrite{get;}
プロパティ値
LOBストリームが書き込み可能の場合は、true
を戻し、それ以外の場合はfalse
を戻します。
このインスタンス・プロパティでは、CLOB
データの取得および書込みに使用するOracleConnection
を示します。
宣言
// C# public OracleConnection Connection {get;}
プロパティ値
OracleConnection
。
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
このインスタンス・プロパティでは、CLOB
が空かどうかを示します。
宣言
// C# public bool IsEmpty {get;}
プロパティ値
bool
。
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
このインスタンス・プロパティでは、索引更新を遅延させるためにCLOB
がオープンされているかどうかを示します。
宣言
// C# public bool IsInChunkWriteMode{get;}
プロパティ値
CLOB
がオープンされている場合はtrue
を戻し、それ以外の場合はfalse
を戻します。
このインスタンス・プロパティは、OracleClob
オブジェクトがNClob
であるかどうかを示します。
宣言
// C# public bool IsNClob {get;}
プロパティ値
bool
。
このプロパティは現行インスタンスにNULL値があるかどうかを示します。
宣言
// C# public bool IsNull{get;}
プロパティ値
現行インスタンスにNULL値がある場合はtrue
、それ以外の場合はfalse
を戻します。
このインスタンス・プロパティでは、現行のインスタンスが一時CLOB
にバインドされているかどうかを示します。
宣言
// C# public bool IsTemporary {get;}
プロパティ値
bool
。
Stream
をオーバーライドします
このインスタンス・プロパティでは、CLOB
データのサイズをバイト数で示します。
宣言
// C# public override Int64 Length {get;}
プロパティ値
CLOB
のサイズをバイト数で示すInt64
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
このインスタンス・プロパティでは、読取りまたは書込み操作中にデータベースから取得または送信する最小バイト数を示します。
宣言
// C# public int OptimumChunkSize{get;}
プロパティ値
取得または送信する最小バイトを表す数
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
Stream
をオーバーライドします
このインスタンスでは、LOBストリームの現行の読取りまたは書込み位置をバイト数で示します。
宣言
// C# public override Int64 Position{get; set;}
プロパティ値
読取りまたは書込み位置を示すInt64
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
ArgumentOutOfRangeException
- Position
は0
未満です。
このプロパティ・インスタンスでは、CLOB
またはNCLOB
の最初の文字を起点とするデータを文字列として戻します。
宣言
// C# public string Value{get;}
プロパティ値
文字列
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
ArgumentOutOfRangeException
- Value
は0
未満です。
備考
このプロパティの使用により、Position
の値が使用または変更されることはありません。
このプロパティが戻すことができる文字列の最大長は2GBです。
OracleClob
インスタンス・メソッドを、表13-27にリストします。
表13-27 OracleClobインスタンス・メソッド
メソッド | 説明 |
---|---|
|
現行の |
|
|
|
|
|
|
|
|
|
現行のストリームをクローズし、関連するすべてのリソースを解除します |
|
現行インスタンスが参照するデータと指定されたオブジェクトのデータを比較します |
|
|
|
|
|
このオブジェクトによって割り当てられたリソースを解除します |
|
現行の |
|
|
|
|
|
|
|
指定されたデータ |
|
サポート対象外 |
|
現行インスタンスのハッシュ・コードを戻します |
|
|
|
|
|
|
|
2つの |
|
現行インスタンスから読み取ります(オーバーロード) |
|
|
|
|
|
現行のLOBストリームに位置を設定します |
|
|
|
|
|
指定された |
|
|
このインスタンス・メソッドでは、現行のOracleClob
インスタンスにデータを追加します。
オーバーロード・リスト:
このインスタンス・メソッドでは、指定されたOracleClob
オブジェクトが参照するCLOB
データを現行のOracleClob
インスタンスに追加します。
このインスタンス・メソッドでは、指定されたバイト配列バッファのオフセット(バイト単位)から始まる、指定されたバイト配列バッファのデータをCLOB
の最後に追加します。
このインスタンス・メソッドでは、指定された文字バッファのオフセット(文字表示)で始まるデータを、指定された文字配列バッファから現行のOracleClob
インスタンスの最後に追加します。
このインスタンス・メソッドでは、指定されたOracleClob
オブジェクトが参照するCLOB
データを現行のOracleClob
インスタンスに追加します。
宣言
// C#
public void Append(OracleClob obj);
パラメータ
obj
OracleClob
オブジェクト。
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- パラメータにオブジェクト以外の接続があるか、OracleConnection
がオープンされていないか、またはOracleConnection
が再オープンされています。
備考
キャラクタ・セット変換は行われません。
指定されたオブジェクトと現行のインスタンスには、同じ接続を使用する必要があります。つまり、同じOracleConnection
オブジェクトを使用します。
このインスタンス・メソッドでは、指定されたバイト配列バッファのオフセット(バイト単位)から始まる、指定されたバイト配列バッファのデータをCLOB
の最後に追加します。
宣言
// C# public int Append(byte[] buffer, int offset, int count);
パラメータ
buffer
Unicode文字列を表すバイト配列
offset
データ読取り元バッファのゼロ・ベースのバイト・オフセット
count
追加するバイト数
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
ArgumentOutOfRangeException
- offset
またはcount
パラメータのいずれかが偶数でない場合。
備考
それぞれ2バイトで1 Unicode文字となるため、CLOB
およびNCLOB
に対するoffset
とcount
の両方が偶数である必要があります。
このインスタンス・メソッドでは、指定された文字バッファのオフセット(文字表示)で始まるデータを、指定された文字配列バッファから現行のOracleClob
インスタンスの最後に追加します。
宣言
// C# public void Append(char[] buffer, int offset, int count);
パラメータ
buffer
文字の配列
offset
データ読取り元バッファのゼロ・ベース・オフセット(文字)
count
追加する文字数
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
例
// C# using System; using Oracle.DataAccess.Client; using Oracle.DataAccess.Types; class AppendSample { static void Main() { string constr = "User Id=scott;Password=tiger;Data Source=oracle"; OracleConnection con = new OracleConnection(constr); con.Open(); OracleClob clob = new OracleClob(con); // Append 2 chars {'d', 'e'} to the OracleClob char[] buffer = new char[3] {'d', 'e', 'f'}; clob.Append(buffer, 0, 2); // Prints "clob.Value = de" Console.WriteLine("clob.Value = " + clob.Value); clob.Close(); clob.Dispose(); con.Close(); con.Dispose(); } }
このインスタンス・メソッドでは、CLOB
をオープンします。
宣言
// C# public void BeginChunkWrite();
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
備考
BeginChunkWrite
をCLOB
データの処理前に呼び出す必要はありません。これはパフォーマンス上の理由で提供されています。
このメソッドを呼び出した後は、書き込み操作を行っても列上のドメインまたは機能ベースの索引は更新されません。索引を更新できるのは、EndChunkWrite
を呼び出した後に1回のみです。
このインスタンス・メソッドでは、OracleClob
オブジェクトのコピーを作成します。
宣言
// C# public object Clone();
戻り値
OracleClob
オブジェクト。
実装
ICloneable
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
備考
複製されたオブジェクトのプロパティ値は、複製元のオブジェクトのプロパティ値と同じです。
例
// C# using System; using Oracle.DataAccess.Client; using Oracle.DataAccess.Types; class CloneSample { static void Main() { string constr = "User Id=scott;Password=tiger;Data Source=oracle"; OracleConnection con = new OracleConnection(constr); con.Open(); OracleClob clob1 = new OracleClob(con); // Prints "clob1.Position = 0" Console.WriteLine("clob1.Position = " + clob1.Position); // Set the Position before calling Clone() clob1.Position = 1; // Clone the OracleClob OracleClob clob2 = (OracleClob)clob1.Clone(); // Prints "clob2.Position = 1" Console.WriteLine("clob2.Position = " + clob2.Position); clob1.Close(); clob1.Dispose(); clob2.Close(); clob2.Dispose(); con.Close(); con.Dispose(); } }
Stream
をオーバーライドします
このインスタンス・メソッドでは、現行ストリームをクローズし、それに関連する任意のリソースを解除します。
宣言
// C# public override void Close();
このインスタンス・メソッドでは、現行のインスタンスが参照するデータと指定されたオブジェクトのデータを比較します。
宣言
// C# public int Compare(Int64 src_offset, OracleClob obj, Int64 dst_offset, Int64 amount);
パラメータ
src_offset
現行インスタンスの比較開始ポイント(文字)
obj
指定されたOracleClob
オブジェクト
dst_offset
指定されたOracleClob
の比較開始ポイント(文字)
amount
比較する文字数
戻り値
メソッドが戻す値は次のとおりです。
ゼロ未満: 現行のインスタンスが参照するデータが、指定されたインスタンスのデータより小さい場合
ゼロ: どちらのオブジェクトも同じデータを参照する場合
ゼロ超過: 現行のインスタンスが参照するデータが、指定されたインスタンスのデータより大きい場合
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- パラメータにオブジェクト以外の接続があるか、OracleConnection
がオープンされていないか、またはOracleConnection
が再オープンされています。
ArgumentOutOfRangeException
- src_offset
、dst_offset
またはamount
パラメータのいずれかが0
より小さい場合。
備考
比較対象の2つのOracleClob
オブジェクトのキャラクタ・セットは、有効な比較に対して同じである必要があります。
指定されたオブジェクトと現行のインスタンスには、同じ接続を使用する必要があります。つまり、同じOracleConnection
オブジェクトを使用します。
CopyTo
では、現行のインスタンスから指定されたOracleClob
オブジェクトにデータをコピーします。
オーバーロード・リスト:
このインスタンス・メソッドでは、現行のインスタンスから指定されたOracleClob
オブジェクトにデータをコピーします。
このインスタンス・メソッドでは、データを現行のOracleClob
インスタンスから指定されたOracleClob
オブジェクトに、指定されたオフセット先とともにコピーします。
CopyTo(Int64, OracleClob, Int64, Int64)
このインスタンス・メソッドでは、データを現行のOracleClob
インスタンスから指定されたOracleClob
オブジェクトに、指定されたソース・オフセット、オフセット先および文字数とともにコピーします。
このインスタンス・メソッドでは、現行のインスタンスから指定されたOracleClob
オブジェクトにデータをコピーします。
宣言
// C#
public Int64 CopyTo(OracleClob obj);
パラメータ
obj
データのコピー先のOracleClob
オブジェクト
戻り値
戻り値はコピーされた数
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- この例外は次のいずれかの条件が存在する場合に表示されます。
OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされた場合
LOBオブジェクト・パラメータにオブジェクト以外の接続がある場合
備考
指定されたオブジェクトと現行のインスタンスには、同じ接続を使用する必要があります。つまり、同じOracleConnection
オブジェクトを使用します。
このインスタンス・メソッドでは、データを現行のOracleClob
インスタンスから指定された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
オブジェクトを使用します。
このインスタンス・メソッドでは、データを現行のOracleClob
インスタンスから指定されたOracleClob
オブジェクトに、指定されたソース・オフセット、オフセット先および文字数とともにコピーします。
宣言
// C# public Int64 CopyTo(Int64 src_offset,OracleClob obj,Int64 dst_offset, Int64 amount);
パラメータ
src_offset
データの読取り元の現行インスタンス内のオフセット(文字)
obj
データのコピー先のOracleClob
オブジェクト
dst_offset
OracleClob
オブジェクトをコピーするオフセット(文字)
amount
コピーするデータ容量
戻り値
戻り値はコピーされた数
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- パラメータにオブジェクト以外の接続があるか、OracleConnection
がオープンされていないか、またはOracleConnection
が再オープンされています。
ArgumentOutOfRangeException
- src_offset
、dst_offset
またはamount
パラメータが0
より小さい場合。
備考
dst_offset
がOracleClob
データの終点を超えている場合は、dst_offset
に到達するまでOracleClob
に空白が書き込まれます。
オフセットは0
ベースです。この操作で文字変換は実行されません。
指定されたオブジェクトと現行のインスタンスには、同じ接続を使用する必要があります。つまり、同じOracleConnection
オブジェクトを使用します。
例
// C# using System; using Oracle.DataAccess.Client; using Oracle.DataAccess.Types; class CopyToSample { static void Main() { string constr = "User Id=scott;Password=tiger;Data Source=oracle"; OracleConnection con = new OracleConnection(constr); con.Open(); OracleClob clob1 = new OracleClob(con); OracleClob clob2 = new OracleClob(con); // Write 4 chars, starting at buffer offset 0 char[] buffer = new char[4] {'a', 'b', 'c', 'd'}; clob1.Write(buffer, 0, 4); // Copy 2 chars from char 0 of clob1 to char 1 of clob2 clob1.CopyTo(0, clob2, 1, 2); //Prints "clob2.Value = ab" Console.WriteLine("clob2.Value = " + clob2.Value); clob1.Close(); clob1.Dispose(); clob2.Close(); clob2.Dispose(); con.Close(); con.Dispose(); } }
このインスタンス・メソッドでは、このオブジェクトによって割り当てられたリソースを解除します。
宣言
public void Dispose();
実装
IDisposable
備考
オブジェクトは、処理後は再度使用できません。一部のプロパティには継続してアクセスできますが、その値は適切ではありません。リソースが解放されているため、メソッドのコールにより例外が発生することがあります。
このインスタンス・メソッドでは、現行のOracleClob
インスタンスが参照するCLOB
をクローズします。
宣言
// C# public void EndChunkWrite();
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
備考
BeginChunkWrite
メソッドによって書込み操作が遅延する場合は、ただちに索引更新が行われます。
Erase
では、データの一部またはすべてを消去します。
オーバーロード・リスト:
このインスタンス・メソッドでは、すべてのデータを消去します。
このインスタンス・メソッドでは、指定されたoffset
で始まる指定されたデータamount
(文字表示)をゼロ・バイト充填文字(文字表示)で置き換えます。
このインスタンス・メソッドでは、指定されたoffset
で始まる指定されたデータamount
(文字表示)をゼロ・バイト充填文字(文字表示)で置き換えます。
宣言
// C# public Int64 Erase(Int64 offset, Int64 amount);
パラメータ
offset
オフセット
amount
データ数
戻り値
消去済実績文字数
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
ArgumentOutOfRangeException
- offset
またはamount
パラメータは0
未満です。
Object
をオーバーライドします
このメソッドにより、現行インスタンスのハッシュ・コードを戻します。
宣言
// C# public override int GetHashCode();
戻り値
ハッシュ・コードを表すint
このインスタンス・メソッドでは、2つのOracleClob
が参照するLOBデータを比較します。
宣言
// C#
public bool IsEqual(OracleClob obj);
パラメータ
obj
OracleClob
オブジェクト。
戻り値
現行のOracleClob
および指定されたOracleClob
が同じLOBを参照する場合は、true
を戻します。それ以外の場合はfalse
を戻します。
備考
2つの異なるOracleClob
インスタンスが同じLOBを参照できるため、2つのOracleClob
オブジェクトが==またはEquals()
に対してfalse
を戻す場合でも、このメソッドではtrue
を戻すことができます。
指定されたオブジェクトと現行のインスタンスには、同じ接続を使用する必要があります。つまり、同じOracleConnection
オブジェクトを使用します。
Read
では、現行インスタンスから指定数を読み取り、配列バッファに移入します。
オーバーロード・リスト:
このインスタンス・メソッドでは、現行のインスタンスから指定バイト数を読み取り、バイト配列buffer
に移入します。
このインスタンス・メソッドでは、現行のインスタンスから指定バイト数を読み取り、文字配列バッファに移入します。
Stream
をオーバーライドします
このインスタンス・メソッドでは、現行のインスタンスから指定バイト数を読み取り、バイト配列buffer
に移入します。
宣言
// C# public override int Read(byte [] buffer, int offset, int count);
パラメータ
buffer
移入されるバイト配列バッファ
offset
バッファに移入されるオフセット(バイト)
count
読み取られるバイト数
戻り値
CLOB
から読み取られるバイト数
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
備考
それぞれ2バイトで1 Unicode文字となるため、CLOB
およびNCLOB
に対するoffset
とcount
の両方が偶数である必要があります。
LOBデータの読取りは、Position
プロパティにより指定された位置から開始されます。その位置は偶数である必要があります。
OracleClob
では、ストリームが終点に達していない場合でも、要求より少ないバイト数を自由に戻すことができます。
このインスタンス・メソッドでは、現行のインスタンスから指定バイト数を読み取り、文字配列バッファに移入します。
宣言
// C# public int Read(char[ ] buffer, int offset, int count);
パラメータ
buffer
移入される文字配列バッファ
offset
バッファに移入されるオフセット(文字)
count
読み取られる文字数
戻り値
戻り値はCLOB
から読み取られる文字数を示します。
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
ArgumentOutOfRangeException
- この例外は次のいずれかの条件が存在する場合に表示されます。
offset
またはcount
が0
未満の場合
offset
がbuffer
.Length
以上である場合
offset
およびcount
の合計がbuffer
.Length
より大きい場合
備考
すべてのCLOB
およびNCLOB
データをUnicodeとして処理します。
LOBデータの読取りは、Position
プロパティにより指定された位置から開始されます。
例
// C# using System; using Oracle.DataAccess.Client; using Oracle.DataAccess.Types; class ReadSample { static void Main() { string constr = "User Id=scott;Password=tiger;Data Source=oracle"; OracleConnection con = new OracleConnection(constr); con.Open(); OracleClob clob = new OracleClob(con); // Write 3 chars, starting at buffer offset 1 char[] writeBuffer = new char[4] {'a', 'b', 'c', 'd'}; clob.Write(writeBuffer, 1, 3); // Reset the Position (in bytes) for Read clob.Position = 2; // Read 2 chars into buffer starting at buffer offset 1 char[] readBuffer = new char[4]; int charsRead = clob.Read(readBuffer, 1, 2); // Prints "charsRead = 2" Console.WriteLine("charsRead = " + charsRead); // Prints "readBuffer = cd " Console.Write("readBuffer = "); for(int index = 0; index < readBuffer.Length; index++) { Console.Write(readBuffer[index]); } Console.WriteLine(); clob.Close(); clob.Dispose(); con.Close(); con.Dispose(); } }
Search
では、OracleClob
の現行のインスタンスの文字パターンを検索します。
オーバーロード・リスト:
このインスタンス・メソッドでは、OracleClob
の現行インスタンスでバイト配列で表される文字パターンを検索します。
このインスタンス・メソッドでは、OracleClob
の現行インスタンスの文字パターンを検索します。
このインスタンス・メソッドでは、OracleClob
の現行インスタンスでバイト配列で表される文字パターンを検索します。
宣言
// C# public int Search(byte[] val, Int64 offset, Int64 nth);
パラメータ
val
Unicodeバイト配列
offset
OracleClob
の検索の起点の0
ベース・オフセット(文字)
nth
絶対オフセット(文字)が戻される特定の一致の出現(1
ベース)
戻り値
一致のnth
回目の出現に対して、一致パターン(バイト表示)の起点の絶対offset
を戻します。それ以外の場合は、0
が戻されます。
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
ArgumentOutOfRangeException
- この例外は次のいずれかの条件が存在する場合に表示されます。
offset
が0
未満の場合
nth
が0
以下の場合
nth
がOracleClob.MaxSize
以上の場合
offset
がOracleClob.MaxSize
以上の場合
備考
byte[
]
は検索前にUnicodeに変換されます。
検索パターンの制限は16383バイトです。
このインスタンス・メソッドでは、OracleClob
の現行インスタンスの文字パターンを検索します。
宣言
// C# public Int64 Search(char [ ] val, Int64 offset, Int64 nth);
パラメータ
val
検索対象のUnicode文字列
offset
OracleClob
の検索の起点の0
ベース・オフセット(文字)
nth
絶対オフセット(文字)が戻される特定の一致の出現(1
ベース)
戻り値
一致のnth
回目の出現に対して、一致パターン(文字表示)の起点の絶対offset
を戻します。それ以外の場合は、0
が戻されます。
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
ArgumentOutOfRangeException
- この例外は次のいずれかの条件が存在する場合に表示されます。
offset
が0
未満の場合
nth
が0
以下の場合
val
.Length
の2倍が16383
より大きい場合
nth
がOracleClob.MaxSize
以上の場合
offset
がOracleClob.MaxSize
以上の場合
備考
検索パターンの制限は16383バイトです。
例
// C# using System; using Oracle.DataAccess.Client; using Oracle.DataAccess.Types; class SearchSample { static void Main() { string constr = "User Id=scott;Password=tiger;Data Source=oracle"; OracleConnection con = new OracleConnection(constr); con.Open(); OracleClob clob = new OracleClob(con); // Write 7 chars, starting at buffer offset 0 char[] buffer = new char[7] {'a', 'b', 'c', 'd', 'a', 'b', 'c'}; clob.Write(buffer, 0, 7); // Search for the 2nd occurrence of a char pattern 'bc' // starting at offset 1 in the OracleBlob char[] pattern = new char[2] {'b', 'c'}; long posFound = clob.Search(pattern, 1, 2); // Prints "posFound = 6" Console.WriteLine("posFound = " + posFound); clob.Close(); clob.Dispose(); con.Close(); con.Dispose(); } }
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
はストリームの終点を指定します。
Stream
をオーバーライドします
このインスタンス・メソッドでは、CLOB
値を指定された長さ(文字表示)に切り捨てます。
宣言
// C#
public override void SetLength(Int64 newlen);
パラメータ
newlen
現行ストリームに必要な長さ(文字)
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
ArgumentOutOfRangeException
- newlen
パラメータは0
より大きい場合。
このインスタンス・メソッドでは、指定された配列バッファからOracleClob
にデータを書き込みます。
オーバーロード・リスト:
このインスタンス・メソッドでは、指定されたバイト配列バッファからOracleClob
にデータを書き込みます。
このインスタンス・メソッドでは、指定された文字配列バッファからOracleClob
にデータを書き込みます。
Stream
をオーバーライドします
このインスタンス・メソッドでは、指定されたバイト配列バッファからOracleClob
にデータを書き込みます。
宣言
// C# public override void Write(byte[ ] buffer, int offset, int count);
パラメータ
buffer
Unicode文字列を表すバイト配列バッファ
offset
buffer
の読取り元のオフセット(バイト)
count
OracleClob
に書き込みされるバッファのデータ数(バイト)
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
ArgumentOutOfRangeException
- この例外は次のいずれかの条件が存在する場合に表示されます。
offset
またはcount
が0
未満の場合
offset
がbuffer
.Length
以上である場合
offset
およびcount
の合計がbuffer
.Length
より大きい場合
offset
、count
またはPosition
が偶数の場合
備考
それぞれ2バイトで1 Unicode文字となるため、CLOB
およびNCLOB
に対するoffset
とcount
の両方が偶数である必要があります。
LOBデータの読取りは、Position
プロパティにより指定された位置から開始されます。Position
プロパティは偶数である必要があります。
必要に応じて、クライアント・キャラクタ・セットからデータベース・キャラクタ・セットに適切なデータ変換が行われます。
このインスタンス・メソッドでは、指定された文字配列バッファからOracleClob
にデータを書き込みます。
宣言
// C# public void Write(char[ ] buffer, int offset, int count);
パラメータ
buffer
OracleClob
に書き込まれた文字配列バッファ
offset
buffer
の読取り元のオフセット(文字)
count
OracleClob
に書き込まれるバッファ数(文字)
例外
ObjectDisposedException
- オブジェクトはすでに処理されています。
InvalidOperationException
- OracleConnection
がオープンされていないか、またはオブジェクトの存続中にクローズされています。
ArgumentOutOfRangeException
- この例外は次のいずれかの条件が存在する場合に表示されます。
offset
またはcount
が0
未満の場合
offset
がbuffer
.Length
以上である場合
offset
およびcount
の合計がbuffer
.Length
より大きい場合
Position
が偶数でない場合
備考
すべてのCLOB
およびNCLOB
データをUnicodeとして処理します。
LOBデータの読取りは、Position
プロパティにより指定された位置から開始されます。
必要に応じて、クライアント・キャラクタ・セットからデータベース・キャラクタ・セットに適切なデータ変換が行われます。
例
// C# using System; using Oracle.DataAccess.Client; using Oracle.DataAccess.Types; class WriteSample { static void Main() { string constr = "User Id=scott;Password=tiger;Data Source=oracle"; OracleConnection con = new OracleConnection(constr); con.Open(); OracleClob clob = new OracleClob(con); // Set the Position for the Write; clob.Position = 0; // Begin ChunkWrite to improve performance // Index updates occur only once after EndChunkWrite clob.BeginChunkWrite(); // Write to the OracleClob in 5 chunks of 2 chars each char[] c = new char[2] {'a', 'b'}; for (int index = 0; index < 5; index++) { clob.Write(c, 0, c.Length); } clob.EndChunkWrite(); // Prints "clob.Value = ababababab" Console.WriteLine("clob.Value = " + clob.Value); clob.Close(); clob.Dispose(); con.Close(); con.Dispose(); } }