15.5.7 HiRDBParameter
- 〈この項の構成〉
(1) コンストラクタ
(a) HiRDBParameter
- void HiRDBParameter ()
-
説明:HiRDBParameter クラスの新しいインスタンスを初期化します。
- void HiRDBParameter (string, object)
-
- 引数
-
string name:割り当てるパラメタの名前(ParameterNameプロパティ)
object value:新しいHiRDBParameterオブジェクトの値(Valueプロパティ)
説明:パラメタ名とHiRDBParameterオブジェクトの値を指定して,HiRDBParameterクラスの新しいインスタンスを初期化します。
- void HiRDBParameter (string, Hitachi.HiRDB.HiRDBType)
-
- 引数
-
string name:割り当てるパラメタの名前(ParameterNameプロパティ)
Hitachi.HiRDB.HiRDBType dataType:HiRDBType値の一つ(HiRDBTypeプロパティ)
説明:パラメタ名とデータ型を指定して,HiRDBParameterクラスの新しいインスタンスを初期化します。
- void HiRDBParameter (string, Hitachi.HiRDB.HiRDBType, int)
-
- 引数
-
string name:割り当てるパラメタの名前(ParameterNameプロパティ)
Hitachi.HiRDB.HiRDBType dataType:HiRDBType値の一つ(HiRDBTypeプロパティ)
int size:パラメタの定義長(Sizeプロパティ)
説明:パラメタ名,データ型,及び長さを使用して,HiRDBParameterクラスの新しいインスタンスを初期化します。
- void HiRDBParameter (string, Hitachi.HiRDB.HiRDBType, int, string)
-
- 引数
-
string name:割り当てるパラメタの名前(ParameterNameプロパティ)
Hitachi.HiRDB.HiRDBType dataType:HiRDBType値の一つ(HiRDBTypeプロパティ)
int size:パラメタの定義長(Sizeプロパティ)
string srcColumn:ソース列の名前(SourceColumnプロパティ)
説明:パラメタ名,データ型,長さ,及びソース列名を指定して,HiRDBParameterクラスの新しいインスタンスを初期化します。
- void HiRDBParameter (string, Hitachi.HiRDB.HiRDBType, int, System.Data.ParameterDirection, byte, byte, string, System.Data.DataRowVersion, object)
-
- 引数
-
string parameterName:パラメタの名前(ParameterNameプロパティ)
Hitachi.HiRDB.HiRDBType dataType:HiRDBType値の一つ(HiRDBTypeプロパティ)
int size:パラメタの定義長(Sizeプロパティ)
System.Data.ParameterDirection direction:ParameterDirection値の一つ(Directionプロパティ)
byte precision:Valueを解決するための,小数点の左右の合計けた数(Precisionプロパティ)
byte scale:Valueを解決するための,小数部のけた数(Scaleプロパティ)
string srcColumn:ソース列の名前(SourceColumnプロパティ)
System.Data.DataRowVersion srcVersion:DataRowVersion値の一つ(SourceVersionプロパティ)
object value:HiRDBParameterの値であるObject(Valueプロパティ)
説明:パラメタ名,データ型,長さ,ソース列名,パラメタの方向,数値の精度,及びそのほかのプロパティを指定して,HiRDBParameterクラスの新しいインスタンスを初期化します。
(2) プロパティ
(a) DbType
型:System.Data.DbType
既定値:DbType.String
説明:パラメタのDbTypeを取得又は設定します。設定時には,表「DbTypeプロパティ設定時に自動設定されるHiRDBTypeプロパティの値」に従って,該当するデータタイプをHiRDBTypeプロパティに設定します。Valueプロパティに値を指定した場合,このプロパティの指定を省略できます。このプロパティの指定を省略した場合,HiRDBデータプロバイダ for .NET FrameworkがDbTypeプロパティの値を仮定します。DbTypeプロパティの仮定値の規則については,「パラメタのデータ長及びデータタイプの仮定」を参照してください。
(b) Direction
型:System.Data.ParameterDirection
既定値:ParameterDirection.Input
説明:パラメタが入力専用,出力専用,双方向,又はストアドプロシジャの戻り値パラメタのどれであるかを示す値を取得又は設定します。
(c) HiRDBType
型:Hitachi.HiRDB.HiRDBType
既定値:HiRDBType.MVarChar
説明:HiRDBでのデータタイプを示す列挙体を取得,又は設定します。設定時には,表「HiRDBTypeプロパティ設定時に自動設定されるDbTypeプロパティの値」に従って,該当するデータタイプをDbTypeプロパティに設定します。Valueプロパティに値を指定した場合,このプロパティの指定を省略できます。このプロパティの指定を省略した場合,HiRDBデータプロバイダ for .NET FrameworkがHiRDBTypeプロパティの値を仮定します。HiRDBTypeプロパティの仮定値の規則については,「パラメタのデータ長及びデータタイプの仮定」を参照してください。
- [HiRDBType列挙体]
-
Integer,SmallInt,Decimal,Float,SmallFlt,Char,VarChar,NChar,NVarChar, MChar,MVarChar,Date,Time,TimeStamp,IntervalYearToDay,IntervalHourToSecond,Blob,Binary
(d) IsNullable
型:bool
既定値:true(固定)
説明:パラメタがnull値を受け付けるかどうかを示す値を取得します(読み取り専用)。null値を受け付ける場合はtrue,それ以外の場合はfalseとなります。
(e) ParameterName
型:string
既定値:""
説明:HiRDBParameterの名前を取得又は設定します。
(f) Precision
型:byte
既定値:0
- 説明:DECIMAL型パラメタの定義長の有効けた数(小数部けた数を含む)を取得又は設定します。
-
- HiRDBTypeプロパティの値がHiRDBType.Decimalの場合:
-
パラメタに対応するHiRDBサーバでのDECIMAL型列の精度を設定してください。
- HiRDBTypeプロパティの値がHiRDBType.Decimal以外の場合:
-
設定値は無視されます。
Valueプロパティに値を指定した場合,このプロパティの指定を省略できます。このプロパティの指定を省略した場合,HiRDBデータプロバイダ for .NET FrameworkがPrecisionプロパティの値を仮定します。Precisionプロパティの仮定値の規則については,「パラメタのデータ長及びデータタイプの仮定」を参照してください。
(g) Repetition
型:short
既定値:1
説明:HiRDBでの配列構造を取得又は設定します。1の場合は対象列を非繰返し列,2以上の場合は繰返し列の最大要素数として扱います。
(h) Scale
型:byte
既定値:0
- 説明:DECIMAL型パラメタの定義長の小数部けた数を取得又は設定します。
-
- HiRDBTypeプロパティの値がHiRDBType.Decimalの場合:
-
パラメタに対応するHiRDBサーバでのDECIMAL型列の位どりを設定してください。
- HiRDBTypeプロパティの値がHiRDBType.Decimal以外の場合:
-
設定値は無視されます。
Valueプロパティに値を指定した場合,このプロパティの指定を省略できます。このプロパティの指定を省略した場合,HiRDBデータプロバイダ for .NET FrameworkがScaleプロパティの値を仮定します。Scaleプロパティの仮定値の規則については,「パラメタのデータ長及びデータタイプの仮定」を参照してください。
(i) Size
型:int
既定値:0
説明:パラメタの定義長を取得又は設定します。固定長(数値型や日時型など)の場合は0を,可変長(文字列型など)の場合はテーブルに格納するバイト数又は列の最大長を設定してください。
- TIMESTAMP(DateTime)の場合は,小数部のけた数となります。
-
- 注
-
Sizeプロパティの設定よりも長い文字列を入力した場合は,Sizeプロパティに設定した長さまでの文字列が格納されます。例外は発生しません。
Valueプロパティに値を指定した場合,このプロパティの指定を省略できます。このプロパティの指定を省略した場合,HiRDBデータプロバイダ for .NET FrameworkがSizeプロパティの値を仮定します。Sizeプロパティの仮定値の規則については,「パラメタのデータ長及びデータタイプの仮定」を参照してください。
(j) SourceColumn
型:string
既定値:""
説明:DataSetに割り当てられ,Valueを読み込むとき,又は戻すときに使用されるソース列の名前を取得又は設定します。
(k) SourceColumnNullMapping
型:bool
既定値:true
説明:パラメタに対応するDataTableオブジェクトの列がNULL値を許すかどうかを示す値を取得又は設定します。
(l) SourceVersion
型:System.Data.DataRowVersion
既定値:DataRowVersion.Default
説明:Valueの読み込みに使用するDataRowVersionを取得又は設定します。
(m) Value
型:object
既定値:null
- 説明:パラメタの値を取得又は設定します。入力,又は入出力用のHiRDBParameterオブジェクトにValueプロパティを指定した場合,次のプロパティの指定を省略できます。
-
-
DbTypeプロパティ
-
HiRDBTypeプロパティ
-
Sizeプロパティ
-
Precisionプロパティ
-
Scaleプロパティ
これらのプロパティの指定を省略した場合,各プロパティの値はHiRDBデータプロバイダ for .NET Frameworkが仮定します。ただし,これらのプロパティを明示的に指定した場合は,HiRDBデータプロバイダ for .NET Frameworkは値を仮定しません。そのため,Valueプロパティに指定する値に合わせて各プロパティを設定する必要があります。詳細は,「パラメタのデータ長及びデータタイプの仮定」を参照してください。
-
(3) メソッド
(a) Clone
object Clone ()
- Return
-
object:このインスタンスのコピーである新しいオブジェクト
説明:現在のインスタンスのコピーである新しいオブジェクトを作成します。
(b) ResetDbType
void ResetDbType ()
Return:void
説明:Valueプロパティが指定されていない場合,DbTypeプロパティの値を初期値に戻します。Valueプロパティに値が指定されている場合,HiRDBデータプロバイダ for .NET Frameworkが,Valueプロパティの値から仮定するDbTypeの値を設定します。データタイプの仮定値の規則については,「パラメタのデータ長及びデータタイプの仮定」を参照してください。DbTypeプロパティの値とHiRDBTypeプロパティの値は1対1で対応しているため,このメソッドを実行するとHiRDBデータプロバイダ for .NET FrameworkがDbTypeプロパティの値に対応する値をHiRDBTypeに設定します。