Parameter オブジェクト

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

解説

多くのプロバイダは、パラメータ化コマンドをサポートしています。このコマンドでは、目的のアクションは一度だけ定義でき、変数 (またはパラメータ) でコマンドの詳細を変更します。たとえば、SQL SELECT ステートメントでは、パラメータを使って、WHERE 句の照合条件を定義したり、SORT BY 句で指定する列名を定義します。

Parameter オブジェクトは、パラメータ クエリに関連付けられたパラメータ、またはストアド プロシージャの入出力引数および戻り値を表します。プロバイダが公開する機能によっては、Parameter オブジェクトの一部のコレクション、メソッド、またはプロパティが使用できない場合があります。

Parameter オブジェクトのコレクション、メソッド、およびプロパティを使って、次の操作を実行できます。

• Name プロパティを使って、パラメータ名を設定したり取得します。
  
  
• Value プロパティを使って、パラメータ値を設定したり取得します。Value は、Parameter オブジェクトの既定プロパティです。
  
  
• Attributes プロパティ、Direction プロパティ、Precision プロパティ、NumericScale プロパティ、Size プロパティ、および Type プロパティを使って、パラメータの特性を設定したり取得します。
  
  
• AppendChunk メソッドを使って、長バイナリ型または文字型データをパラメータに渡します。

呼び出すストアド プロシージャまたはパラメータ クエリに関連付けられたパラメータの名前とそのプロパティが明らかな場合、CreateParameter メソッドを使って適切なプロパティ設定を持つ Parameter オブジェクトを作成し、Append メソッドを使ってそれらを Parameters コレクションに追加することができます。この操作により、Parameters コレクションで Refresh メソッドを呼び出してプロバイダからパラメータ情報を取得するというリソースに負担のかかる操作をしなくても、パラメータ値を設定したり取得することができます。