Parametersコレクション

パラメータ クエリまたはストアド プロシージャに基づく、Command オブジェクトに関連付けられたパラメータまたは引数を表します。

* Count
* Append
* Delete
* Item
* Refresh


AppendChunk

(PWS4 IIS4 IIS5)
AppendChunk — 大きなサイズの文字列または Parameter オブジェクトにデータを追加します。

構文

object.AppendChunk Data

パラメータ

object Field オブジェクトまたは Parameter オブジェクトを指定します。
Data オブジェクトに追加するデータを含むバリアント型 (Variant) のデータを指定します。

説明

AppendChunk メソッドを使って、Field オブジェクトまたは Parameter オブジェクトに長バイナリまたは文字データを格納します。システムのメモリに制限がある場合、AppendChunk メソッドを使うと、長い値をいくつかのセグメントに分けて操作できます。

Parameter オブジェクトの Attributes プロパティで adFldLong ビットが True (1) に設定されている場合、その Parameter オブジェクトに AppendChunk メソッドを使用することができます。

Parameter オブジェクトで AppendChunk メソッドを最初に呼び出したときは、パラメータの既存データに上書きしてデータが書き込まれます。Parameter オブジェクトで AppendChunk メソッドを続けて呼び出したときは、既存のパラメータ データに追加されます。AppendChunk メソッドの呼び出しで Null 値を渡すと、すべてのパラメータ データが破棄されます。


Value

(PWS4 IIS4 IIS5)
Value — Parameter オブジェクトに割り当てられた値を示します。

構文

object.Value

パラメータ

object Parameter オブジェクを指定します。

設定値と戻り値

オブジェクトの値を表すバリアント型 (Variant) の値を設定します。また、値の取得も可能です。既定値は、Type プロパティの設定によって異なります。

説明

Parameter オブジェクトでパラメータ値を設定または取得するときは、Value プロパティを使います。Value プロパティは、状況に応じて読み取り/書き込み可能になったり、読み取り専用になります。詳細については、関連するオブジェクトのトピックを参照してください。

ADO では、Value プロパティを使って長バイナリ型 (Long Binary) データを設定したり、返すことができます。

注意 Parameter オブジェクトの場合、ADO は、プロバイダから一度だけ Value プロパティを読み取ります。コマンドに Value プロパティが空の Parameter があり、そのコマンドから Recordset を作成する場合は、Value プロパティを取得する前に必ず Recordset を閉じてください。そうしないと、プロバイダによっては Value プロパティが空になり、正しい値が設定されないことがあります。


Type

(PWS4 IIS4 IIS5)
Type — Parameter オブジェクト、Field オブジェクト、または Property オブジェクトの操作の種類またはデータ型を示します。

構文

object.Type

パラメータ

object Parameter オブジェクを指定します。

設定値と戻り値

DataTypeEnum 値を設定します。また、値の取得も可能です。

説明

Parameter オブジェクトでは、Type プロパティは読み取り/書き込み可能です。


Size

(PWS4 IIS4 IIS5)
Size — Parameter オブジェクトの最大サイズをバイト数または文字数で示します。

構文

object.Size

パラメータ

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

設定値と戻り値

Parameter オブジェクトの最大サイズをバイト数または文字数で示す、長整数型 (Long) の値を設定します。また、値の取得も可能です。

説明

Parameter オブジェクトの Value プロパティに対して書き取り/読み取り可能な値の最大値を調べるには、Size プロパティを使います。

Parameter オブジェクトで可変長データ型 (たとえば adVarChar などのすべての文字列型 (String)) を指定した場合、Parameters コレクションにそれを追加する前にオブジェクトの Size プロパティを設定する必要があります。この設定が行われていない場合は、エラーが発生します。

Command オブジェクトの Parameters コレクションに既に Parameter オブジェクトが追加されている場合、そのデータ型を可変長データ型に変更するためには、Command オブジェクトを実行する前に Parameter オブジェクトの Size プロパティを設定する必要があります。この設定が行われていない場合は、エラーが発生します。

Refresh メソッドを実行してプロバイダからパラメータ情報を取得したときに、1 つ以上の可変長データ型の Parameter オブジェクトが返された場合、パラメータサイズの上限を基にメモリがパラメータに割り当てられます。実行時にこの操作が行われると、エラーが発生します。エラーを避けるには、コマンドの実行前に、これらのパラメータの Size プロパティを明示的に設定しておきます。

Size プロパティは読み取り/書き込み可能です。


Precision

(PWS4 IIS4 IIS5)
Precision — Parameter オブジェクトの数値型 (Numeric) の精度を示します。

構文

object.Precision

パラメータ

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

設定値と戻り値

値を表す場合の最大桁数を示すバイト型 (Byte) の値を設定します。また、値の取得も可能です。

説明

数値型の Parameter オブジェクトで使用される数値の最大桁数を指定するには、Precision プロパティを使います。

Parameter オブジェクトでは、値は読み取り/書き込み可能です。


NumericScale

(PWS4 IIS4 IIS5)
NumericScale — Parameter オブジェクトで、数値型 (Numeric) の値の桁数を示します。

構文

object.NumericScale

パラメータ

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

設定値と戻り値

数値を処理するときの小数点以下の桁数を示す Byte 値を設定します。また、値の取得も可能です。

説明

数値型の Parameter オブジェクトの値の小数点以下の桁数は、NumericScale プロパティを使って指定します。

Parameter オブジェクトでは、NumericScale プロパティは読み取り/書き込み可能になっています。


Name

(PWS4 IIS4 IIS5)
Name — オブジェクトの名前を示します。

構文

object.Name

パラメータ

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

設定値と戻り値

オブジェクトの名前を示す文字列型 (String) の値を設定します。また、値の取得も可能です。

説明

Parameter オブジェクト名を設定または取得します。

Parameters コレクションに追加されていない Parameter オブジェクトでは、Name プロパティの属性は読み取り/書き込み可能になっています。追加された Parameter オブジェクトとその他のオブジェクトでは、Name プロパティは読み取り専用です。名前はコレクション内で一意でなくてもかまいません。

オブジェクトの Name プロパティは、その序数参照で取得することができ、その後は、その名前で直接オブジェクトを参照できます。たとえば、 rstMain.Properties(20).Name で Updatability を取得すると、次からはこのプロパティを rstMain.Properties(“Updatability”) で参照できます。


Direction

(PWS4 IIS4 IIS5)
Direction — Parameter が、入力パラメータ、出力パラメータ、または入出力両方のパラメータを表しているか、あるいは、ストアド プロシージャからの戻り値であるかを示します。

構文

object.Direction = value

パラメータ

object Parameter オブジェクトを指定します。
value オブジェクトの入出力方向

以下の値が value パラメータ文字列として認識されます

定数 内容
adParamUnKnown 0 パラメータ方向不明
adParamInput 1 入力パラメータ(デフォルト)
adParamOutput 2 出力パラメータ
adParamInputOutput 3 入出力パラメータ
adParamReturnValue 4 戻り値

設定値と戻り値

ParameterDirectionEnum の値を設定します。また、値の取得も可能です。

説明

プロシージャとのパラメータのやり取りの方法を指定するには、Direction プロパティを使います。Direction プロパティは読み取り/書き込み可能になっています。そのため、この情報を返したり、指定できないプロバイダを使用するときでも、パラメータ情報の取得のために ADO がそれ以上プロバイダを呼び出さないようにすることができます。

プロバイダの中には、ストアド プロシージャのパラメータの入出力の方向を確認できないものがあります。この場合は、クエリを実行する前に Direction プロパティを設定します。


Attributes

(PWS4 IIS4 IIS5)
Attributes — オブジェクトの 1 つ以上の特性を示します。

構文

object.Attributes = value

パラメータ

object Parameter オブジェクトを指定します。
value オブジェクトの属性を指定します。

以下の値が value パラメータ文字列として認識されます

定数 内容
adParamSigned 16 符号付きの値を指定
adParamNullable 64 Nullを指定
adParamLong 128 長バイナリ型のデータを指定

設定値と戻り値

長整数型 (Long) の値を設定します。また、値の取得も可能です。

Attributes プロパティは 1 つ以上の FieldAttributeEnum 値の和になります。通常は読み取り専用ですが、Record の Fields コレクションに追加された新規 Field オブジェクトの場合、Field の Value プロパティが指定されていて、データ プロバイダが Fields コレクションの Update メソッドを呼び出して新規 Field の追加に成功した場合に限り、Attributes は読み取り/書き込み可能になります。

説明

Parameter オブジェクトの場合、Attributes プロパティは読み取り/書き込み可能で、その値は 1 つ以上の ParameterAttributesEnum 値の和になります。既定値は adParamSigned です。

Property オブジェクトの場合、Attributes プロパティは読み取り専用で、その値は、1 つ以上の PropertyAttributesEnum 値の和になります。