Parameter オブジェクト (バージョン 2.0、2.1、2.5、2.6)

Parameter オブジェクトは、SQL ステートメントまたはストアドプロシージャ内の 1 つの変数の情報を保持します。Parameter オブジェクトの組み合わせは、Command オブジェクトの Parameters コレクションに属します。

Parameter.AppendChunk メソッド (バージョン 2.0、2.1、2.5、2.6)

parameter.AppendChunk Data
 

AppendChunk メソッドは、データを現在の Parameter オブジェクト内の大きなデータまたはバイナリフィールドに追加します。

パラメータ
Data

唯一のパラメータである Data は、現在の Parameter オブジェクトに追加する大量のデータを保持する Variant データタイプです。

 
説明

AppendChunk メソッドは、大量のテキストまたはバイナリデータを既存の Parameter オブジェクトに追加します。これは、実行する操作に必要なメモリに比べて、現在のシステムのメモリが限定されている場合に非常に便利です。AppendChunk メソッドを使用すると、データを適切な単位で段階的に Field オブジェクトに追加できます。

Parameter オブジェクトの AppendChunk メソッドを呼び出すには、Parameter オブジェクトに属する Arguments プロパティの adFldLong ビットを設定する必要があります。

Parameter オブジェクト上で AppendChunk メソッドを複数回呼び出して、データをオブジェクト内の既存のデータに追加します。Parameter オブジェクト内のデータをクリアする唯一の方法は、オブジェクトを長さが 0 の文字列に設定することです。Null 値を Parameter オブジェクトの AppendChunk メソッドに渡すと、エラーが発生します。

 
関連項目

Parameter.Arguments プロパティ

 
Parameter.Attributes プロパティ (バージョン 2.0、2.1、2.5、2.6)

parameter.Attributes = ParameterAttributesEnum
 

Attributes プロパティは、Parameter オブジェクトに固有の属性を設定または返します。

データタイプ

ParameterAttributesEnum (Long)

 
説明

Arguments プロパティは、読み取りおよび書き込み可能です。Arguments プロパティの値は、付録 E に示す ParameterArgumentsEnum 列挙値のいずれかの合計に設定できます。Arguments プロパティのデフォルト値は adParamSigned です。

 
関連項目

ParameterAttributesEnum 列挙

 
Parameter.Direction プロパティ (バージョン 2.0、2.1、2.5、2.6)

parameter.Direction = ParameterDirectionEnum
 

Direction プロパティは、現在のパラメータが入力パラメータ、出力パラメータ、入出力パラメータ、またはストアドプロシージャからの戻り値かどうかを指定します。

データタイプ

ParameterDirectionEnum (Long)

 
説明

Direction プロパティは、読み取りおよび書き込みのどちらも可能です。ADO がこの情報の検索のためにデータプロバイダへの追加呼び出しを行わないで済むように、パラメータを手動で Parameters コレクションに追加すると便利です。場合によっては、特定のデータプロバイダでこの情報を判断できないため、Direction プロパティを手動で指定する必要があります。

Direction プロパティは、付録 E に示すいずれかの ParameterDirectionEnum 列挙に設定できます。

 
メモ

すべてのプロバイダが Direction プロパティの値を判断できるわけではありません。このため、そのようなプロバイダについては、Direction プロパティの値を使用する前に、アプリケーションでこの値を手動で設定する必要があります。

 
関連項目

ParameterDirectionEnum 列挙

 
Parameter.Name プロパティ (バージョン 2.0、2.1、2.5、2.6)

parameter.Name = Name
 

Name プロパティは、現在の Parameter オブジェクトの名前を指定します。

データタイプ

String

 
説明

Name プロパティは、Parameter オブジェクトに対して読み取りおよび書き込み可能です。Name プロパティを設定できるのは、Parameter オブジェクトがまだ Parameters コレクションに追加されていない場合のみです。

Name プロパティは、名前を関連する Parameter オブジェクトに割り当てるか、Parameters コレクションから Parameter オブジェクトを取得します。

名前は Parameters コレクションオブジェクト内で一意である必要はありません。

 
Parameter.NumericScale プロパティ (バージョン 2.0、2.1、2.5、2.6)

numberscale = parameter.NumericScale
 

NumericScale プロパティは、現在の Parameter オブジェクトの数値のサイズを示します。

データタイプ

Byte

 
説明

NumericScale プロパティは、Parameter オブジェクトに対して読み取りおよび書き込み可能です。数値 Parameter オブジェクトの小数点以下のバイト数を識別します。

 
Parameter.Precision プロパティ (バージョン 2.0、2.1、2.5、2.6)

precision = parameter.Precision
 

Precision プロパティは、現在の Parameter オブジェクト内の数値の精度を表します。

データタイプ

Byte

 
説明

Precision プロパティは、Parameter オブジェクトに対して読み取りおよび書き込み可能です。このプロパティは、数値 Parameter オブジェクトの値の表現に使用される、総桁数を示すバイト型の値です。

 
Parameter.Properties コレクション (バージョン 2.0、2.1、2.5、2.6)

Set properties = parameter.Properties
 

Properties コレクションは、現在使用されているプロバイダの Parameter オブジェクトに固有の属性を保持する、Properties コレクションクラスを返します。

データタイプ

Properties (Collection オブジェクト)

 
説明

Properties コレクションクラスは、データプロバイダの Parameter オブジェクトに固有の各プロパティに対する、Property クラスのインスタンスを保持します。

 
Parameter.Size プロパティ (バージョン 2.0、2.1、2.5、2.6)

parameter.Size = size
 

Size プロパティは、Parameter オブジェクトの値の最大サイズを返します。

データタイプ

Long

 
説明

Size プロパティは、パラメータの値の最大サイズをバイト数で返します。このプロパティは、読み取りおよび書き込み可能です。

Parameter オブジェクトが可変長のデータタイプである場合、Parameters コレクションに追加する前に、Size プロパティを設定する必要があります。さもなければ、エラーが発生します。

Parameter オブジェクトのデータタイプを可変長のデータタイプに変更する場合、最初に Size プロパティを設定してエラーが発生しないようにする必要があります。

Command オブジェクトの Execute メソッドを呼び出す前に、Parameter オブジェクトの Size プロパティも設定する必要があります。その理由は、この設定を行わないでかつ可変長のデータタイプが存在する場合、ADO では、必要な最大量のメモリを割り当てようとするため、エラーが発生するからです。

 
Parameter.Type プロパティ (バージョン 2.0、2.1、2.5、2.6)

parameter.Type = DataTypeEnum
 

Type プロパティは、現在のオブジェクトのデータタイプを識別します。

データタイプ

DataTypeEnum (Long)

 
説明

Type プロパティは、Parameter オブジェクトに対して読み取りおよび書き込み可能です。このプロパティは、数値 Parameter オブジェクトの値の表現に使用される、総桁数を示すバイト型の値です。

 
関連項目

DataTypeEnum 列挙

 
Parameter.Value プロパティ (バージョン 2.0、2.1、2.5、2.6)

parameter.Value = value
 

Value プロパティは、現在の Parameter オブジェクトに割り当てられている値を示します。

データタイプ

Variant

 
説明

Value プロパティは、関連する Parameter オブジェクトの値の読み取りおよび設定を行います。Value プロパティは、ADO を介して Long 型のバイナリデータをサポートします。

ADO は、Parameter オブジェクトの Value プロパティを一度だけ読み取ります。空の Value プロパティを持つパラメータを含むコマンドを実行し、そのコマンドがレコードセットを作成する場合、Value プロパティを読み取る前にレコードセットを閉じる必要があります。

 
Parameters コレクション

Set parameters = command.Parameters
Set fields = recordset.Fields
 

Parameters コレクションに関する詳細と例については、「Parameter オブジェクト」を参照してください。

オブジェクト
Parameter

SQL ステートメント、クエリー、またはストアドプロシージャに属する特定のパラメータに関する情報を保持します。

 
メソッド
Append

新しい Parameter オブジェクトを現在の Parameters コレクションクラスに追加します。

Delete

Parameters コレクションクラスから Parameter オブジェクトを削除します。

Refresh

現在のストアドプロシージャのパラメータ、または Parameters コレクションが属する Command オブジェクトに関連するパラメータ化されたクエリーのパラメータを使用して、コレクションを更新します。

 
プロパティ
Count

関連する Parameters コレクションに属する Parameter オブジェクトの数を示します。

Item

Parameters コレクションに属する特定の Parameter オブジェクトにアクセスします。

 
Parameters.Append メソッド (バージョン 2.0、2.1、2.5、2.6)

parameters.Append Object
 

Append メソッドは、新しい Parameter オブジェクトを現在の Parameters コレクションクラスに追加します。

パラメータ
オブジェクト

Append メソッドの唯一のパラメータは、Parameter オブジェクトです。実際に Append メソッドを呼び出す前に、Parameter オブジェクトの Type プロパティを設定する必要があります。さらに、Parameter のデータタイプが可変長の場合、Parameter オブジェクトの Size プロパティを 0 より大きい値に設定する必要があります。

 
説明

Parameters コレクションの Append メソッドは、ストアドプロシージャまたはパラメータ化されたクエリーに指定されているパラメータのタイプを ADO に通知します。この処理を行う理由は、いくつかあります。1 つは、この情報の取得のために行われるデータプロバイダへの呼び出しを最小化することで、ストアドプロシージャまたはパラメータ化されたクエリーの処理に要する時間を減らせることです。パラメータを Parameters コレクションに追加することでパラメータを事前に宣言するもう 1 つの理由は、必ずしもすべてのデータプロバイダが実際にこの情報を ADO に通知しないことです。このため、Parameters コレクションを自分自身で追加しない限り、これらのストアドプロシージャまたはクエリーをまったく使用できない可能性が高くなります。

Microsoft も推奨していますが、できる限り常に、ストアドプロシージャまたはパラメータ化されたクエリーのパラメータを事前に宣言することをお勧めします。ADO で使用可能な情報に常に依存できないためであり、このことで速度のさらなる利点が損なわれないからです。

 
関連項目

Command.CreateParameter メソッド、Parameter.Size プロパティ、Parameter.Type プロパティ

 
Parameters.Count プロパティ (バージョン 2.0、2.1、2.5、2.6)

count = parameters.Count
 

Count プロパティは、関連する Parameters コレクションに属する Parameter オブジェクトの数を示します。

データタイプ

Long

 
説明

Count プロパティの値が 0 の場合、関連する Parameters コレクション内には Parameter オブジェクトはありません。ただし、関連する Parameters コレクションに属する Parameter オブジェクトには、0 〜 (Count プロパティの値 - 1) のインデックスが設定されます。

 
Parameters.Delete メソッド (バージョン 2.0、2.1、2.5、2.6)

parameters.Delete Index
 

Delete メソッドは、Parameters コレクションクラスから Parameter オブジェクトを削除します。

パラメータ
Index

Index パラメータは、削除対象の Parameter オブジェクトの名前またはその順序のいずれかです。

 
説明

Parameters コレクションクラスの Delete メソッドは、コレクションから Parameter オブジェクトを削除します。Delete メソッドは、コレクション内の有効な Parameter オブジェクトの名前またはその順序を渡すことで、指定された Parameter オブジェクトを関連する Parameters コレクションクラスから削除します。

 
関連項目

Parameter.Name プロパティ

 
Parameters.Item プロパティ (バージョン 2.0、2.1、2.5、2.6)

Set error = errors.Item(Index)
Set error = errors (Index)
 

Item プロパティは、Parameters コレクションに属する特定の Parameter オブジェクトにアクセスします。

データタイプ

Object

 
説明

Index プレースホルダーは、Parameters コレクション内の Parameter オブジェクトの順序を表す Variant データタイプです。Parameters コレクションに要求された項目がない場合、エラーが発生します。

 
メモ

言語によっては、最初の構文の Item プロパティをサポートしていないものもあります。それらの言語では、Item メソッド名なしの 2 番目の構文を使用します。

 
Parameters.Refresh メソッド (バージョン 2.0、2.1、2.5、2.6)

parameters.Refresh
 

Parameters コレクションの Refresh メソッドは、現在のストアドプロシージャのパラメータ、または Parameters コレクションが属する Command オブジェクトに関連するパラメータ化されたクエリーのパラメータを使用して、コレクションを更新します。

説明

Refresh メソッドは、関連する Command オブジェクトのストアドプロシージャまたはパラメータ化されたクエリーのパラメータを使用して、Parameters コレクションを更新します。

Refresh メソッドを呼び出す前に Parameters コレクションクラスへのアクセスを試みると、このメソッドが ADO から自動的に呼び出されます。