Parameters コレクション (ADO)Parameters Collection (ADO)

すべてが含まれています、パラメーターのオブジェクトをコマンドオブジェクト。Contains all the Parameter objects of a Command object.

コメントRemarks

Aコマンドオブジェクトには、パラメーターから成るコレクションパラメーターオブジェクト。A Command object has a Parameters collection made up of Parameter objects.

使用して、更新メソッドをコマンドオブジェクトのパラメーターコレクションは、ストアド プロシージャまたはパラメーター化されたクエリ プロバイダー パラメーター情報を取得します。指定されている、コマンドオブジェクト。Using the Refresh method on a Command object's Parameters collection retrieves provider parameter information for the stored procedure or parameterized query specified in the Command object. ストアド プロシージャの呼び出しまたはパラメーター化されたクエリの一部のプロバイダーをサポートしません。呼び出す、更新メソッドをパラメーターコレクションがこのようなプロバイダーを使用する場合はエラーを返します。Some providers do not support stored procedure calls or parameterized queries; calling the Refresh method on the Parameters collection when using such a provider will return an error.

独自に定義するしていない場合パラメーターオブジェクトとしたアクセス、パラメーターコレクションを呼び出す前に、更新メソッド、ADO の呼び出しが自動的に、メソッドのコレクション。If you have not defined your own Parameter objects and you access the Parameters collection before calling the Refresh method, ADO will automatically call the method and populate the collection for you.

呼び出すストアド プロシージャに関連付けられたまたはパラメーター化されたクエリ パラメーターのプロパティがわかっている場合は、パフォーマンスを向上させるために、プロバイダーに呼び出しを最小限に抑えることができます。You can minimize calls to the provider to improve performance if you know the properties of the parameters associated with the stored procedure or parameterized query you wish to call. 使用して、 CreateParameterメソッドを作成するパラメーターオブジェクトを使用して適切なプロパティの設定、 Appendメソッドに追加する、 パラメーターコレクション。Use the CreateParameter method to create Parameter objects with the appropriate property settings and use the Append method to add them to the Parameters collection. これにより設定およびパラメーターについては、プロバイダーに連絡しなくてもパラメーターの値を取得できます。This lets you set and return parameter values without having to call the provider for the parameter information. 手動で設定する必要がある、パラメーター情報を提供しないプロバイダーを作成している場合、パラメーターこのメソッドを使用して、すべてのパラメーターを使用することができるコレクションです。If you are writing to a provider that does not supply parameter information, you must manually populate the Parameters collection using this method to be able to use parameters at all. 使用して、削除を削除するパラメーターオブジェクトから、パラメーターコレクションのために必要な場合。Use the Delete method to remove Parameter objects from the Parameters collection if necessary.

内のオブジェクト、パラメーターのコレクションをレコード セット(したがって利用できなくなる) のスコープ外に移動時に、レコード セットが閉じられました。The objects in the Parameters collection of a Recordset go out of scope (therefore becoming unavailable) when the Recordset is closed.

使用してストアド プロシージャを呼び出すときにコマンド、ストアド プロシージャの戻り値の出力パラメーターは次のように取得されます。When calling a stored procedure with Command, the return value/output parameter of a stored procedure is retrieved as follows:

  1. パラメーター、ストアド プロシージャを呼び出すことがあるないとき、更新メソッドをパラメーターコレクションを呼び出す前に呼び出す必要があります、 Executeメソッドをコマンドオブジェクト。When calling a stored procedure that has no parameters, the Refresh method on the Parameters collection should be called before calling the Execute method on the Command object.

  2. パラメーターとパラメーターを明示的に追加することをストアド プロシージャを呼び出すときに、パラメーターコレクション追加、戻り値の出力パラメーターが、に追加されるパラメーターコレクション。When calling a stored procedure with parameters and explicitly appending a parameter to the Parameters collection with Append, the return value/output parameter should be appended to the Parameters collection. 戻り値にまず追加する必要があります、パラメーターコレクション。The return value must first be appended to the Parameters collection. 使用Appendに他のパラメーターを追加する、パラメーター定義の順序のコレクション。Use Append to add the other parameters into the Parameters collection in the order of definition. たとえば、ストアド プロシージャ SPWithParam では、2 つのパラメーターがあります。For example, the stored procedure SPWithParam has two parameters. 最初のパラメーターでは、、adVarChar (20) として定義されている入力パラメーターと 2 番目のパラメーターは、 OutParamadVarChar (20) として定義されている出力パラメーターです。The first parameter, InParam, is an input parameter defined as adVarChar (20), and the second parameter, OutParam, is an output parameter defined as adVarChar (20). 次のコードで戻り値の出力パラメーターを取得することができます。You can retrieve the return value/output parameter with the following code.

    ' Open Connection Conn  
    set ccmd = CreateObject("ADODB.Command")  
    ccmd.Activeconnection= Conn  
    
    ccmd.CommandText="SPWithParam"  
    ccmd.commandType = 4 'adCmdStoredProc  
    
    ccmd.parameters.Append ccmd.CreateParameter(, adInteger, adParamReturnValue, , NULL)   ' return value  
    ccmd.parameters.Append ccmd.CreateParameter("InParam", adVarChar, adParamInput, 20, "hello world")   ' input parameter  
    ccmd.parameters.Append ccmd.CreateParameter("OutParam", adVarChar, adParamOutput, 20, NULL)   ' output parameter  
    
    ccmd.execute()  
    
    ' Access ccmd.parameters(0) as return value of this stored procedure  
    ' Access ccmd.parameters("OutParam") as the output parameter of this stored procedure.  
    
    
  3. パラメーターと呼び出すことによって、パラメーターの構成を使用してストアド プロシージャを呼び出すときに、項目メソッドをパラメーターコレクション、ストアド プロシージャの戻り値の出力パラメーターのことができます取得する、パラメーターコレクション。When calling a stored procedure with parameters and configuring the parameters by calling the Item method on the Parameters collection, the return value/output parameter of the stored procedure can be retrieved from the Parameters collection. たとえば、ストアド プロシージャ SPWithParam では、2 つのパラメーターがあります。For example, the stored procedure SPWithParam has two parameters. 最初のパラメーターでは、、adVarChar (20) として定義されている入力パラメーターと 2 番目のパラメーターは、 OutParamadVarChar (20) として定義されている出力パラメーターです。The first parameter, InParam, is an input parameter defined as adVarChar (20), and the second parameter, OutParam, is an output parameter defined as adVarChar (20). 次のコードで戻り値の出力パラメーターを取得することができます。You can retrieve the return value/output parameter with the following code.

    ' Open Connection Conn  
    set ccmd = CreateObject("ADODB.Command")  
    ccmd.Activeconnection= Conn  
    
    ccmd.CommandText="SPWithParam"  
    ccmd.commandType = 4 'adCmdStoredProc  
    
    ccmd.parameters.Item("InParam").value = "hello world" ' input parameter  
    ccmd.execute()  
    
    ' Access ccmd.parameters(0) as return value of stored procedure  
    ' Access ccmd.parameters(2) or ccmd.parameters("OutParam") as the output parameter.  
    

このセクションには、次のトピックが含まれています。This section contains the following topic.

参照See Also

Append メソッド (ADO) Append Method (ADO)
CreateParameter メソッド (ADO) CreateParameter Method (ADO)
Parameter オブジェクトParameter Object